loci.formats.in

Class JPEG2000MetadataParser

java.lang.Object

loci.formats.in.JPEG2000MetadataParser

public class JPEG2000MetadataParser
extends java.lang.Object

A parser for JPEG 2000 metadata.

Source code:

Trac, Gitweb

Constructor Summary

Constructors

Constructor and Description
JPEG2000MetadataParser(RandomAccessInputStream in) Constructs a new JPEG2000MetadataParser.
JPEG2000MetadataParser(RandomAccessInputStream in, long maximumReadOffset) Constructs a new JPEG2000MetadataParser.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCodestreamOffset() Retrieves the offset to the first contiguous codestream.
java.lang.Integer	getCodestreamPixelType() Returns the pixel type as specified in the header.
java.lang.Short	getCodestreamSizeC() Returns the number of channels the image has as specified in the header.
java.lang.Integer	getCodestreamSizeX() Returns the width of the image as specified in the header.
java.lang.Integer	getCodestreamSizeY() Returns the height of the image as specified in the header.
java.util.ArrayList<java.lang.String>	getComments() Retrieves the list of comments stored in the file.
java.lang.Integer	getHeaderPixelType() Returns the pixel type as specified in the header.
java.lang.Short	getHeaderSizeC() Returns the number of channels the image has as specified in the header.
java.lang.Integer	getHeaderSizeX() Returns the width of the image as specified in the header.
java.lang.Integer	getHeaderSizeY() Returns the height of the image as specified in the header.
int[][]	getLookupTable() Returns the color lookup table stored in the file, or null if a lookup table is not present.
java.lang.Integer	getResolutionLevels() Returns the number of resolution levels the file JPEG 2000 data has.
boolean	isRawCodestream() Whether or not the codestream is raw and not JP2 boxed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JPEG2000MetadataParser

public JPEG2000MetadataParser(RandomAccessInputStream in)
                       throws java.io.IOException

Constructs a new JPEG2000MetadataParser.

Parameters:

in - Stream to parse JPEG 2000 metadata from.

Throws:

java.io.IOException - Thrown if there is an error reading from the file.

JPEG2000MetadataParser

public JPEG2000MetadataParser(RandomAccessInputStream in,
                      long maximumReadOffset)
                       throws java.io.IOException

Constructs a new JPEG2000MetadataParser.

Parameters:

in - Stream to parse JPEG 2000 metadata from.

maximumReadOffset - Maximum read offset within the stream when parsing.

Throws:

java.io.IOException - Thrown if there is an error reading from the file.

Method Detail

getCodestreamOffset

public long getCodestreamOffset()

Retrieves the offset to the first contiguous codestream.

getComments

public java.util.ArrayList<java.lang.String> getComments()

Retrieves the list of comments stored in the file.

isRawCodestream

public boolean isRawCodestream()

Whether or not the codestream is raw and not JP2 boxed.

Returns:

true if the codestream is raw and false otherwise.

getResolutionLevels

public java.lang.Integer getResolutionLevels()

Returns the number of resolution levels the file JPEG 2000 data has.

Returns:

The number of resolution levels or null if the number cannot be parsed.

getHeaderSizeX

public java.lang.Integer getHeaderSizeX()

Returns the width of the image as specified in the header.

Returns:

See above.

getHeaderSizeY

public java.lang.Integer getHeaderSizeY()

Returns the height of the image as specified in the header.

Returns:

See above.

getHeaderSizeC

public java.lang.Short getHeaderSizeC()

Returns the number of channels the image has as specified in the header.

Returns:

See above.

getHeaderPixelType

public java.lang.Integer getHeaderPixelType()

Returns the pixel type as specified in the header.

Returns:

See above.

getCodestreamSizeX

public java.lang.Integer getCodestreamSizeX()

Returns the width of the image as specified in the header.

Returns:

See above.

getCodestreamSizeY

public java.lang.Integer getCodestreamSizeY()

Returns the height of the image as specified in the header.

Returns:

See above.

getCodestreamSizeC

public java.lang.Short getCodestreamSizeC()

Returns the number of channels the image has as specified in the header.

Returns:

See above.

getCodestreamPixelType

public java.lang.Integer getCodestreamPixelType()

Returns the pixel type as specified in the header.

Returns:

See above.

getLookupTable

public int[][] getLookupTable()

Returns the color lookup table stored in the file, or null if a lookup table is not present.

Returns:

See above.