io.scif.formats

Class JPEG2000Format.Parser

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

io.scif.AbstractHasSource

io.scif.AbstractGroupable

io.scif.AbstractParser<JPEG2000Format.Metadata>

io.scif.formats.JPEG2000Format.Parser

All Implemented Interfaces:

Groupable, HasFormat, HasSource, Parser, SCIFIOPlugin, TypedParser<JPEG2000Format.Metadata>, Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Identifiable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.plugin.HasPluginInfo, org.scijava.plugin.RichPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.Prioritized, org.scijava.Versioned

Enclosing class:

JPEG2000Format

public static class JPEG2000Format.Parser
extends AbstractParser<JPEG2000Format.Metadata>

Constructor Summary

Constructors

Constructor and Description
Parser()

Method Summary

Modifier and Type	Method and Description
long	getCodestreamOffset() Retrieves the offset to the first contiguous codestream.
Integer	getCodestreamPixelType() Returns the pixel type as specified in the header.
Short	getCodestreamSizeC() Returns the number of channels the image has as specified in the header.
Integer	getCodestreamSizeX() Returns the width of the image as specified in the header.
Integer	getCodestreamSizeY() Returns the height of the image as specified in the header.
ArrayList<String>	getComments() Retrieves the list of comments stored in the file.
Integer	getHeaderPixelType() Returns the pixel type as specified in the header.
Short	getHeaderSizeC() Returns the number of channels the image has as specified in the header.
Integer	getHeaderSizeX() Returns the width of the image as specified in the header.
Integer	getHeaderSizeY() Returns the height of the image as specified in the header.
boolean	isRawCodestream() Whether or not the codestream is raw and not JP2 boxed.
void	parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream, JPEG2000Format.Metadata meta, long maximumReadOffset)
protected void	typedParse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream, JPEG2000Format.Metadata meta, SCIFIOConfig config) A helper method, called by AbstractParser.parse(DataHandle, TypedMetadata).

Methods inherited from class io.scif.AbstractParser

close, getAdvancedImageUsedLocations, getAdvancedUsedLocations, getImageUsedFiles, getImageUsedFiles, getMetadata, getSource, getSourceLocation, getSupportedMetadataLevels, getUsedFiles, getUsedLocations, parse, parse, parse, parse, parse, parse, parse, parse, parse, parse, parse, setMetaData, updateSource

Methods inherited from class io.scif.AbstractGroupable

fileGroupOption, hasCompanionFiles, isSingleFile

Methods inherited from class io.scif.AbstractHasSource

close

Methods inherited from class io.scif.AbstractHasFormat

asBrowsableLocation, asBrowsableLocation, getFormat, getFormatName

Methods inherited from class io.scif.AbstractSCIFIOPlugin

getVersion, log

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.scif.HasFormat

getFormat, getFormatName

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface io.scif.HasSource

close

Methods inherited from interface io.scif.Groupable

fileGroupOption, hasCompanionFiles, isSingleFile

Constructor Detail

Parser

public Parser()

Method Detail

parse

public void parse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream,
                  JPEG2000Format.Metadata meta,
                  long maximumReadOffset)
           throws IOException

Throws:

IOException

typedParse

protected void typedParse(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> stream,
                          JPEG2000Format.Metadata meta,
                          SCIFIOConfig config)
                   throws IOException,
                          FormatException

Description copied from class: AbstractParser

A helper method, called by AbstractParser.parse(DataHandle, TypedMetadata). Allows for boilerplate code to come after parsing, specifically calls to Metadata.populateImageMetadata().

This method should be implemented to populate any format-specific Metadata.

NB: if a Format requires type-specific parsing to occur before the Abstract layer, Override #parse(String, TypedMetadata) instead.

Specified by:

typedParse in class AbstractParser<JPEG2000Format.Metadata>

Throws:

IOException

FormatException

getCodestreamOffset

public long getCodestreamOffset()

Retrieves the offset to the first contiguous codestream.

getComments

public ArrayList<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.

getHeaderSizeX

public Integer getHeaderSizeX()

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

Returns:

See above.

getHeaderSizeY

public Integer getHeaderSizeY()

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

Returns:

See above.

getHeaderSizeC

public Short getHeaderSizeC()

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

Returns:

See above.

getHeaderPixelType

public Integer getHeaderPixelType()

Returns the pixel type as specified in the header.

Returns:

See above.

getCodestreamSizeX

public Integer getCodestreamSizeX()

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

Returns:

See above.

getCodestreamSizeY

public Integer getCodestreamSizeY()

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

Returns:

See above.

getCodestreamSizeC

public Short getCodestreamSizeC()

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

Returns:

See above.

getCodestreamPixelType

public Integer getCodestreamPixelType()

Returns the pixel type as specified in the header.

Returns:

See above.