io.scif.formats

Class NRRDFormat.Reader

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

io.scif.AbstractHasSource

io.scif.AbstractGroupable

io.scif.AbstractReader<M,ByteArrayPlane>

io.scif.ByteArrayReader<NRRDFormat.Metadata>

io.scif.formats.NRRDFormat.Reader

All Implemented Interfaces:

Groupable, HasFormat, HasSource, Reader, SCIFIOPlugin, TypedReader<NRRDFormat.Metadata,ByteArrayPlane>, 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:

NRRDFormat

public static class NRRDFormat.Reader
extends ByteArrayReader<NRRDFormat.Metadata>

Constructor Summary

Constructors

Constructor and Description
Reader()

Method Summary

Modifier and Type	Method and Description
protected String[]	createDomainArray() Helper method to lazily create the domain array for this reader instance, to avoid constantly re-creating the array.
int	fileGroupOption(org.scijava.io.location.Location id) Returns an int indicating that we cannot, must, or might group the files in a given dataset.
long	getOptimalTileHeight(int imageIndex) Returns the optimal sub-image height for use with Reader.openPlane(int, long).
boolean	hasCompanionFiles() Returns true if this format supports multi-file datasets.
boolean	isSingleFile(org.scijava.io.location.Location id) Returns true if this is a single-file format.
ByteArrayPlane	openPlane(int imageIndex, long planeIndex, ByteArrayPlane plane, net.imglib2.Interval bounds, SCIFIOConfig config)

Methods inherited from class io.scif.ByteArrayReader

createPlane, createPlane

Methods inherited from class io.scif.AbstractReader

castToTypedPlane, close, getCurrentLocation, getDomains, getHandle, getImageCount, getMetadata, getOptimalTileWidth, getPlaneClass, getPlaneCount, isNormalized, openPlane, openPlane, openPlane, openPlane, openPlane, openPlane, openPlane, openPlane, openPlane, openPlane, openPlane, readPlane, readPlane, readPlane, readPlane, setMetadata, setMetadata, setNormalized, setSource, setSource, setSource, setSource

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

Constructor Detail

Reader

public Reader()

Method Detail

createDomainArray

protected String[] createDomainArray()

Description copied from class: AbstractReader

Helper method to lazily create the domain array for this reader instance, to avoid constantly re-creating the array.

Specified by:

createDomainArray in class AbstractReader<NRRDFormat.Metadata,ByteArrayPlane>

hasCompanionFiles

public boolean hasCompanionFiles()

Description copied from interface: Groupable

Returns true if this format supports multi-file datasets.

Specified by:

hasCompanionFiles in interface Groupable

Specified by:

hasCompanionFiles in interface Reader

Overrides:

hasCompanionFiles in class AbstractReader<NRRDFormat.Metadata,ByteArrayPlane>

isSingleFile

public boolean isSingleFile(org.scijava.io.location.Location id)
                     throws FormatException,
                            IOException

Description copied from interface: Groupable

Returns true if this is a single-file format.

Specified by:

isSingleFile in interface Groupable

Overrides:

isSingleFile in class AbstractGroupable

Throws:

FormatException

IOException

fileGroupOption

public int fileGroupOption(org.scijava.io.location.Location id)
                    throws FormatException,
                           IOException

Description copied from interface: Groupable

Returns an int indicating that we cannot, must, or might group the files in a given dataset.

Specified by:

fileGroupOption in interface Groupable

Overrides:

fileGroupOption in class AbstractGroupable

Throws:

FormatException

IOException

getOptimalTileHeight

public long getOptimalTileHeight(int imageIndex)

Description copied from interface: Reader

Returns the optimal sub-image height for use with Reader.openPlane(int, long).

Specified by:

getOptimalTileHeight in interface Reader

Overrides:

getOptimalTileHeight in class AbstractReader<NRRDFormat.Metadata,ByteArrayPlane>

openPlane

public ByteArrayPlane openPlane(int imageIndex,
                                long planeIndex,
                                ByteArrayPlane plane,
                                net.imglib2.Interval bounds,
                                SCIFIOConfig config)
                         throws FormatException,
                                IOException

Throws:

FormatException

IOException

See Also:

TypedReader.openPlane(int, long, DataPlane, Interval)