NrrdInfo (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- nrrd.NrrdInfo

```
public class NrrdInfo
extends Object
```
This class contains the key information that describes a nrrd file The expectation is that it will be generated by parsing an existing file before loading. It will also be generated before saving a file. It should be handed off to NrrdFile reader/writer in order to save/load It is conceptually similar to ImageJ's FileInfo class, but I have decided not to derive it from that because I would like to make this package detachable from ImageJ.

Author:

jefferis

Field Summary

Fields
Modifier and Type	Field and Description
`File[]`	`dataFiles`
`static String[]`	`int16Types`
`static String[]`	`int32Types`
`static String[]`	`int64Types`
`static String[]`	`int8Types`
`static int`	`NRRD_BIG_ENDIAN`
`static int`	`NRRD_DIM_MAX`
`static int`	`NRRD_FALSE`
`static int`	`NRRD_LITTLE_ENDIAN`
`static int`	`NRRD_SPACE_DIM_MAX`
`static int`	`NRRD_TRUE`
`static int`	`NRRD_UNKNOWN`
`String`	`primaryFileDirectory`
`String`	`primaryFileName`
`static String[]`	`uint16Types`
`static String[]`	`uint32Types`
`static String[]`	`uint64Types`
`static String[]`	`uint8Types`

Constructor Summary

Constructors
Constructor and Description

NrrdInfo(NrrdHeader nh)
Constructor takes a NrrdHeader as argument

Constructors
Constructor and Description
`NrrdInfo(NrrdHeader nh)` Constructor takes a NrrdHeader as argument

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double[]`	`getDoubleField(String key)`
`double[]`	`getDoubleFieldChecked(String key, int n, boolean required)`
`int[]`	`getIntegerField(String key)`
`int[]`	`getIntegerFieldChecked(String key, int n, boolean required)`
`long[]`	`getLongField(String key)`
`long[]`	`getLongFieldChecked(String key, int n, boolean required)`
`String`	`getStandardType(String stype)`
`String[]`	`getStringField(String key)`
`String[]`	`getStringFieldChecked(String key, int n, boolean required)`
`static void`	`main(String[] args)`
`void`	`parseHeader()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NRRD_DIM_MAX
```
public static final int NRRD_DIM_MAX
```
See Also:

Constant Field Values

NRRD_SPACE_DIM_MAX
```
public static final int NRRD_SPACE_DIM_MAX
```
See Also:

Constant Field Values

NRRD_UNKNOWN
```
public static final int NRRD_UNKNOWN
```
See Also:

Constant Field Values

NRRD_FALSE
```
public static final int NRRD_FALSE
```
See Also:

Constant Field Values

NRRD_TRUE
```
public static final int NRRD_TRUE
```
See Also:

Constant Field Values

NRRD_BIG_ENDIAN
```
public static final int NRRD_BIG_ENDIAN
```
See Also:

Constant Field Values

NRRD_LITTLE_ENDIAN
```
public static final int NRRD_LITTLE_ENDIAN
```
See Also:

Constant Field Values

primaryFileDirectory
```
public String primaryFileDirectory
```

primaryFileName
```
public String primaryFileName
```

dataFiles
```
public File[] dataFiles
```

int8Types
```
public static final String[] int8Types
```

uint8Types

public static final String[] uint8Types

int16Types

public static final String[] int16Types

uint16Types

public static final String[] uint16Types

int32Types

public static final String[] int32Types

uint32Types

public static final String[] uint32Types

int64Types

public static final String[] int64Types

uint64Types

public static final String[] uint64Types

Constructor Detail
- NrrdInfo
```
public NrrdInfo(NrrdHeader nh)
```
  Constructor takes a NrrdHeader as argument
  
  Parameters:
  
  nh -

Method Detail

parseHeader

public void parseHeader()
                 throws Exception

Throws:: Exception

getStandardType

public String getStandardType(String stype)

getStringField

public String[] getStringField(String key)

getDoubleField

public double[] getDoubleField(String key)

getLongField

public long[] getLongField(String key)

getIntegerField

public int[] getIntegerField(String key)

getStringFieldChecked

public String[] getStringFieldChecked(String key,
                                      int n,
                                      boolean required)
                               throws Exception

Throws:: Exception

getIntegerFieldChecked

public int[] getIntegerFieldChecked(String key,
                                    int n,
                                    boolean required)
                             throws Exception

Throws:: Exception

getLongFieldChecked

public long[] getLongFieldChecked(String key,
                                  int n,
                                  boolean required)
                           throws Exception

Throws:: Exception

getDoubleFieldChecked

public double[] getDoubleFieldChecked(String key,
                                      int n,
                                      boolean required)
                               throws Exception

Throws:: Exception

main

public static void main(String[] args)

Class NrrdInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NRRD_DIM_MAX

NRRD_SPACE_DIM_MAX

NRRD_UNKNOWN

NRRD_FALSE

NRRD_TRUE

NRRD_BIG_ENDIAN

NRRD_LITTLE_ENDIAN

primaryFileDirectory

primaryFileName

dataFiles

int8Types

uint8Types

int16Types

uint16Types

int32Types

uint32Types

int64Types

uint64Types

Constructor Detail

NrrdInfo

Method Detail

parseHeader

getStandardType

getStringField

getDoubleField

getLongField

getIntegerField

getStringFieldChecked

getIntegerFieldChecked

getLongFieldChecked

getDoubleFieldChecked

main