AmiraParameters (Bio-Formats API)

java.lang.Object
- loci.formats.tools.AmiraParameters

```
public class AmiraParameters
extends Object
```
AmiraParameters handles parsing and writing of AmiraMesh headers.

Author:

Gregory Jefferis jefferis at gmail.com, Johannes Schindelin johannes.schindelin at gmx.de

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`ascii`
`protected char`	`c`
`protected int`	`column`
`int`	`depth`
`int`	`firstDataStream`
`int`	`height`
`protected loci.common.RandomAccessInputStream`	`in`
`boolean`	`littleEndian`
`protected Map`	`map`
`int`	`nStreams`
`protected int`	`row`
`String[]`	`streamNames`
`protected Map`	`streams`
`String[]`	`streamTypes`
`int`	`width`
`double`	`x0`
`double`	`x1`
`double`	`y0`
`double`	`y1`
`double`	`z0`
`double`	`z1`

Constructor Summary

Constructors
Constructor and Description

AmiraParameters(loci.common.RandomAccessInputStream inputStream)

AmiraParameters(String path)

Constructors
Constructor and Description
`AmiraParameters(loci.common.RandomAccessInputStream inputStream)`
`AmiraParameters(String path)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`entryToString(Object object, String indent)`
`protected void`	`extractCoreMetaData()`
`Map`	`getMap()`
`Map`	`getStreams()`
`static void`	`main(String[] args)`
`protected char`	`readByte()`
`protected Double[]`	`readDoubleArray(int count)`
`protected void`	`readFile(loci.common.RandomAccessInputStream inputStream)`
`protected void`	`readFile(String path)`
`protected Integer[]`	`readIntArray()`
`protected Integer[]`	`readIntArray(int count)`
`protected String`	`readKey()`
`protected Map`	`readMap()`
`protected Number`	`readNumber()`
`protected Number[]`	`readNumberArray()`
`protected String`	`readQuotedString()`
`protected void`	`readTopLevel()`
`protected void`	`skipComment()`
`protected void`	`skipWhiteSpace()`
`protected void`	`syntaxError(String message)`
`String`	`toString()`
`static String`	`toString(Map map, String indent)`

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

Field Detail

width
```
public int width
```

height
```
public int height
```

depth
```
public int depth
```

firstDataStream
```
public int firstDataStream
```

x0
```
public double x0
```

y0
```
public double y0
```

z0
```
public double z0
```

x1
```
public double x1
```

y1
```
public double y1
```

z1
```
public double z1
```

littleEndian
```
public boolean littleEndian
```

ascii
```
public boolean ascii
```

nStreams
```
public int nStreams
```

streamNames
```
public String[] streamNames
```

streamTypes
```
public String[] streamTypes
```

in

protected transient loci.common.RandomAccessInputStream in

map
```
protected Map map
```

streams
```
protected Map streams
```

column
```
protected int column
```

row
```
protected int row
```

c
```
protected char c
```

Constructor Detail

AmiraParameters

public AmiraParameters(String path)
                throws FormatException

Throws:: FormatException

AmiraParameters

public AmiraParameters(loci.common.RandomAccessInputStream inputStream)
                throws FormatException,
                       IOException

Throws:: FormatException; IOException

Method Detail

readFile

protected void readFile(String path)
                 throws FormatException

Throws:: FormatException

readFile

protected void readFile(loci.common.RandomAccessInputStream inputStream)
                 throws FormatException,
                        IOException

Throws:: FormatException; IOException

extractCoreMetaData

protected void extractCoreMetaData()
                            throws FormatException

Throws:: FormatException

syntaxError

protected void syntaxError(String message)
                    throws FormatException

Throws:: FormatException

readTopLevel

protected void readTopLevel()
                     throws FormatException,
                            IOException

Throws:: FormatException; IOException

readByte

protected char readByte()
                 throws IOException

Throws:: IOException

skipComment

protected void skipComment()
                    throws IOException

Throws:: IOException

skipWhiteSpace

protected void skipWhiteSpace()
                       throws IOException

Throws:: IOException

readKey

protected String readKey()
                  throws IOException

Throws:: IOException

readNumber

protected Number readNumber()
                     throws FormatException,
                            IOException

Throws:: FormatException; IOException

readIntArray

protected Integer[] readIntArray()
                          throws FormatException,
                                 IOException

Throws:: FormatException; IOException

readNumberArray

protected Number[] readNumberArray()
                            throws FormatException,
                                   IOException

Throws:: FormatException; IOException

readIntArray

protected Integer[] readIntArray(int count)
                          throws FormatException,
                                 IOException

Throws:: FormatException; IOException

readDoubleArray

protected Double[] readDoubleArray(int count)
                            throws FormatException,
                                   IOException

Throws:: FormatException; IOException

readQuotedString

protected String readQuotedString()
                           throws FormatException,
                                  IOException

Throws:: FormatException; IOException

readMap

protected Map readMap()
               throws FormatException,
                      IOException

Throws:: FormatException; IOException

getMap
```
public Map getMap()
```

getStreams
```
public Map getStreams()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

toString

public static String toString(Map map,
                              String indent)
                       throws FormatException

Throws:: FormatException

entryToString

public static String entryToString(Object object,
                                   String indent)
                            throws FormatException

Throws:: FormatException

main

public static void main(String[] args)

Class AmiraParameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

width

height

depth

firstDataStream

x0

y0

z0

x1

y1

z1

littleEndian

ascii

nStreams

streamNames

streamTypes

in

map

streams

column

row

c

Constructor Detail

AmiraParameters

AmiraParameters

Method Detail

readFile

readFile

extractCoreMetaData

syntaxError

readTopLevel

readByte

skipComment

skipWhiteSpace

readKey

readNumber

readIntArray

readNumberArray

readIntArray

readDoubleArray

readQuotedString

readMap

getMap

getStreams

toString

toString

entryToString

main