DatastreamParser (Bio-Formats API)

java.lang.Object
- ome.jxr.parser.Parser
- - ome.jxr.parser.DatastreamParser

```
public final class DatastreamParser
extends Parser
```
Parses the initial elements (image header, image plane headers(-s)) of the image codestream. Conducts validation of values according to the file format specification.

Author:

Blazej Pindelski bpindelski at dundee.ac.uk

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`alphaImagePlaneFlag`
`private FrequencyBand`	`bandsPresent`
`private int`	`bottomMargin`
`private int`	`chromaCenteringX`
`private int`	`chromaCenteringY`
`private int`	`expBias`
`private boolean`	`frequencyModeCodestreamFlag`
`private boolean`	`hardTilingFlag`
`private int`	`heightMinus1`
`private boolean`	`hpImagePlaneUniformFlag`
`private boolean`	`indexTablePresentFlag`
`private InternalColorFormat`	`internalClrFmt`
`private int`	`leftMargin`
`private int`	`lenMantissa`
`private boolean`	`longWordFlag`
`private boolean`	`lpImagePlaneUniformFlag`
`private int`	`numComponents`
`private int`	`numComponentsExtendedMinus16`
`private int`	`numComponentsMinus1`
`private int`	`numHorTilesMinus1`
`private int`	`numVerTilesMinus1`
`private BitDepth`	`outputBitdepth`
`private OutputColorFormat`	`outputClrFmt`
`private int`	`overlapMode`
`private boolean`	`premultipliedAlphaFlag`
`private boolean`	`redBlueNotSwappedFlag`
`private int`	`reservedB`
`private int`	`reservedD`
`private int`	`rightMargin`
`private boolean`	`scaledFlag`
`private int`	`shiftBits`
`private boolean`	`shortHeaderFlag`
`private int`	`spatialXfrmSubordinate`
`private short[]`	`tileHeightInMB`
`private short[]`	`tileWidthInMB`
`private boolean`	`tilingFlag`
`private int`	`topMargin`
`private boolean`	`trimFlexbitsFlag`
`private int`	`widthMinus1`
`private boolean`	`windowingFlag`

Fields inherited from class ome.jxr.parser.Parser
parsingOffset, stream

Constructor Summary

Constructors
Constructor and Description

DatastreamParser(Parser parentParser, RandomAccessInputStream stream)

Constructors
Constructor and Description
`DatastreamParser(Parser parentParser, RandomAccessInputStream stream)`

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`checkGDISignaturePresence()`
`void`	`close()`
`void`	`parse()`
`private void`	`parseImageHeader()`
`private void`	`parsePrimaryImagePlaneHeader()`
`private void`	`verifyImageHeaderConformance()`
`private void`	`verifyPrimaryImagePlaneHeaderConformance()`

Methods inherited from class ome.jxr.parser.Parser
getParentParser, parse

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

Field Detail

reservedB
```
private int reservedB
```

hardTilingFlag
```
private boolean hardTilingFlag
```

tilingFlag
```
private boolean tilingFlag
```

frequencyModeCodestreamFlag

private boolean frequencyModeCodestreamFlag

spatialXfrmSubordinate
```
private int spatialXfrmSubordinate
```

indexTablePresentFlag
```
private boolean indexTablePresentFlag
```

overlapMode
```
private int overlapMode
```

shortHeaderFlag
```
private boolean shortHeaderFlag
```

longWordFlag
```
private boolean longWordFlag
```

windowingFlag
```
private boolean windowingFlag
```

trimFlexbitsFlag
```
private boolean trimFlexbitsFlag
```

reservedD
```
private int reservedD
```

redBlueNotSwappedFlag
```
private boolean redBlueNotSwappedFlag
```

premultipliedAlphaFlag
```
private boolean premultipliedAlphaFlag
```

alphaImagePlaneFlag
```
private boolean alphaImagePlaneFlag
```

outputClrFmt
```
private OutputColorFormat outputClrFmt
```

outputBitdepth
```
private BitDepth outputBitdepth
```

widthMinus1
```
private int widthMinus1
```

heightMinus1
```
private int heightMinus1
```

numVerTilesMinus1
```
private int numVerTilesMinus1
```

numHorTilesMinus1
```
private int numHorTilesMinus1
```

tileWidthInMB
```
private short[] tileWidthInMB
```

tileHeightInMB
```
private short[] tileHeightInMB
```

topMargin
```
private int topMargin
```

leftMargin
```
private int leftMargin
```

bottomMargin
```
private int bottomMargin
```

rightMargin
```
private int rightMargin
```

internalClrFmt

private InternalColorFormat internalClrFmt

scaledFlag
```
private boolean scaledFlag
```

bandsPresent
```
private FrequencyBand bandsPresent
```

chromaCenteringX
```
private int chromaCenteringX
```

chromaCenteringY
```
private int chromaCenteringY
```

numComponentsMinus1
```
private int numComponentsMinus1
```

numComponentsExtendedMinus16

private int numComponentsExtendedMinus16

numComponents
```
private int numComponents
```

shiftBits
```
private int shiftBits
```

lenMantissa
```
private int lenMantissa
```

expBias
```
private int expBias
```

lpImagePlaneUniformFlag

private boolean lpImagePlaneUniformFlag

hpImagePlaneUniformFlag

private boolean hpImagePlaneUniformFlag

Constructor Detail

DatastreamParser

public DatastreamParser(Parser parentParser,
                RandomAccessInputStream stream)
                 throws JXRException

Throws:: JXRException

Method Detail

parse

public void parse()
           throws JXRException

Overrides:: parse in class Parser
Throws:: JXRException

checkGDISignaturePresence

private void checkGDISignaturePresence()
                                throws IOException,
                                       JXRException

Throws:: IOException; JXRException

parseImageHeader

private void parseImageHeader()
                       throws IOException

Throws:: IOException

verifyImageHeaderConformance

private void verifyImageHeaderConformance()
                                   throws JXRException

Throws:: JXRException

parsePrimaryImagePlaneHeader

private void parsePrimaryImagePlaneHeader()
                                   throws IOException

Throws:: IOException

verifyPrimaryImagePlaneHeaderConformance

private void verifyPrimaryImagePlaneHeaderConformance()
                                               throws JXRException

Throws:: JXRException

close

public void close()
           throws IOException

Overrides:: close in class Parser
Throws:: IOException

Class DatastreamParser

Field Summary

Fields inherited from class ome.jxr.parser.Parser

Constructor Summary

Method Summary

Methods inherited from class ome.jxr.parser.Parser

Methods inherited from class java.lang.Object

Field Detail

reservedB

hardTilingFlag

tilingFlag

frequencyModeCodestreamFlag

spatialXfrmSubordinate

indexTablePresentFlag

overlapMode

shortHeaderFlag

longWordFlag

windowingFlag

trimFlexbitsFlag

reservedD

redBlueNotSwappedFlag

premultipliedAlphaFlag

alphaImagePlaneFlag

outputClrFmt

outputBitdepth

widthMinus1

heightMinus1

numVerTilesMinus1

numHorTilesMinus1

tileWidthInMB

tileHeightInMB

topMargin

leftMargin

bottomMargin

rightMargin

internalClrFmt

scaledFlag

bandsPresent

chromaCenteringX

chromaCenteringY

numComponentsMinus1

numComponentsExtendedMinus16

numComponents

shiftBits

lenMantissa

expBias

lpImagePlaneUniformFlag

hpImagePlaneUniformFlag

Constructor Detail

DatastreamParser

Method Detail

parse

checkGDISignaturePresence

parseImageHeader

verifyImageHeaderConformance

parsePrimaryImagePlaneHeader

verifyPrimaryImagePlaneHeaderConformance

close