loci.formats.in

Class LeicaSCNReader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.SubResolutionFormatReader

loci.formats.in.MinimalTiffReader

loci.formats.in.BaseTiffReader

loci.formats.in.LeicaSCNReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, IFormatHandler, IFormatReader, IMetadataConfigurable, IPyramidHandler

public class LeicaSCNReader
extends BaseTiffReader

LeicaSCNReader is the file format reader for Leica SCN TIFF files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	LeicaSCNReader.Dimension
(package private) class	LeicaSCNReader.Image
(package private) class	LeicaSCNReader.ImageCollection
(package private) class	LeicaSCNReader.LeicaSCNHandler SAX handler for parsing XML in Leica SCN files.
(package private) class	LeicaSCNReader.Pixels

Field Summary

Fields

Modifier and Type	Field and Description
(package private) LeicaSCNReader.LeicaSCNHandler	handler
private static org.slf4j.Logger	LOGGER Logger for this class.
private static java.lang.String	SCHEMA_2010_03
private static java.lang.String	SCHEMA_2010_10

Fields inherited from class loci.formats.in.BaseTiffReader

DATE_FORMATS

Fields inherited from class loci.formats.in.MinimalTiffReader

canSeparateSeries, equalStrips, ifds, lastPlane, mergeSubIFDs, noSubresolutions, seriesToIFD, subResolutionIFDs, thumbnailIFDs, tiffParser, use64Bit

Fields inherited from class loci.formats.SubResolutionFormatReader

core

Fields inherited from class loci.formats.FormatReader

coreIndex, datasetDescription, domains, filterMetadata, flattenedResolutions, group, hasCompanionFiles, in, indexedAsRGB, metadata, metadataStore, normalizeData, resolution, saveOriginalMetadata, series, suffixNecessary, suffixSufficient, THUMBNAIL_DIMENSION

Fields inherited from class loci.formats.FormatHandler

COMPRESSION_SUFFIXES, currentId, format, metadataOptions, suffixes

Fields inherited from interface loci.formats.IFormatReader

CAN_GROUP, CANNOT_GROUP, MUST_GROUP

Constructor Summary

Constructors

Constructor and Description
LeicaSCNReader() Constructs a new LeicaSCN reader.

Method Summary

Modifier and Type	Method and Description
void	close(boolean fileOnly) Closes the currently open file.
int	getOptimalTileHeight() Returns the optimal sub-image height for use with openBytes.
int	getOptimalTileWidth() Returns the optimal sub-image width for use with openBytes.
private int	getParent(int coreIndex)
int	getThumbSizeX() Get the size of the X dimension for the thumbnail.
int	getThumbSizeY() Get the size of the Y dimension for the thumbnail.
private int	imageIFD(int no)
protected void	initCoreMetadata(int series, int resolution)
protected void	initMetadataStore() Populates the metadata store using the data parsed in BaseTiffReader.initStandardMetadata() along with some further parsing done in the method itself.
protected void	initStandardMetadata() Parses standard metadata.
protected void	initTiffParser() Reinitialize the underlying TiffParser.
boolean	isThisType(java.lang.String name, boolean open) Checks if a file matches the type of this format reader.
byte[]	openBytes(int no, byte[] buf, int x, int y, int w, int h) Obtains a sub-image of the specified image plane into a pre-allocated byte array.
byte[]	openThumbBytes(int no) Obtains a thumbnail for the specified image plane from the current file, as a byte array.

Methods inherited from class loci.formats.in.BaseTiffReader

getExifTagName, getImageCreationDate, initFile, initMetadata, put, put, put, put, put, put, put, put, put, put, putDouble, putInt, putString

Methods inherited from class loci.formats.in.MinimalTiffReader

get16BitLookupTable, get8BitLookupTable, getIFDs, getThumbnailIFDs, isThisType, reopenFile, setResolutionLevel

Methods inherited from class loci.formats.SubResolutionFormatReader

coreIndexToSeries, flattenHashtables, getCoreIndex, getCoreMetadataList, getCurrentCore, getResolution, getResolutionCount, getSeries, getSeriesCount, seriesToCoreIndex, setCoreIndex, setResolution, setSeries

Methods inherited from class loci.formats.FormatReader

addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMetaList, addMeta, addMetaList, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMetaList, close, fileGroupOption, getAcquisitionMode, getAdvancedSeriesUsedFiles, getAdvancedUsedFiles, getArcType, getAvailableOptions, getBinning, getBitsPerPixel, getCompression, getContrastMethod, getCorrection, getCurrentFile, getDatasetStructureDescription, getDetectorType, getDimensionOrder, getDimensionOrder, getDomains, getEffectiveSizeC, getExperimentType, getFilamentType, getFillRule, getFilterType, getFontFamily, getFontStyle, getGlobalMeta, getGlobalMetadata, getIlluminationType, getImageCount, getImmersion, getIndex, getIndex, getLaserMedium, getLaserType, getMarker, getMedium, getMetadataStore, getMetadataStoreRoot, getMetadataValue, getMicrobeamManipulationType, getMicroscopeType, getModuloC, getModuloT, getModuloZ, getNamingConvention, getPixelType, getPixelType, getPossibleDomains, getPulse, getRequiredDirectories, getRGBChannelCount, getRotationTransform, getSeriesMeta, getSeriesMetadata, getSeriesMetadataValue, getSeriesUsedFiles, getSeriesUsedFiles, getSizeC, getSizeT, getSizeX, getSizeY, getSizeZ, getUnderlyingReaders, getUsedFiles, getUsedFiles, getZCTCoords, getZCTModuloCoords, hasCompanionFiles, hasFlattenedResolutions, isFalseColor, isGroupFiles, isIndexed, isInterleaved, isInterleaved, isLittleEndian, isMetadataComplete, isMetadataFiltered, isNormalized, isOrderCertain, isOriginalMetadataPopulated, isRGB, isSingleFile, isThisType, isThisType, isThumbnailSeries, isUsedFile, makeFilterMetadata, openBytes, openBytes, openBytes, openPlane, readPlane, readPlane, setFlattenedResolutions, setGroupFiles, setId, setMetadataFiltered, setMetadataStore, setNormalized, setOriginalMetadataPopulated, updateMetadataLists

Methods inherited from class loci.formats.FormatHandler

checkSuffix, checkSuffix, getFormat, getMetadataOptions, getNativeDataType, getSuffixes, getSupportedMetadataLevels, setMetadataOptions

Methods inherited from class java.lang.Object

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

Methods inherited from interface loci.formats.IFormatHandler

getFormat, getNativeDataType, getSuffixes

Methods inherited from interface loci.formats.IMetadataConfigurable

getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

Logger for this class.

SCHEMA_2010_03

private static final java.lang.String SCHEMA_2010_03

See Also:

Constant Field Values

SCHEMA_2010_10

private static final java.lang.String SCHEMA_2010_10

See Also:

Constant Field Values

handler

LeicaSCNReader.LeicaSCNHandler handler

Constructor Detail

LeicaSCNReader

public LeicaSCNReader()

Constructs a new LeicaSCN reader.

Method Detail

isThisType

public boolean isThisType(java.lang.String name,
                          boolean open)

Description copied from class: FormatReader

Checks if a file matches the type of this format reader. Checks filename suffixes against those known for this format. If the suffix check is inconclusive and the open parameter is true, the file is opened and tested with FormatReader.isThisType(RandomAccessInputStream).

Specified by:

isThisType in interface IFormatReader

Overrides:

isThisType in class FormatReader

open - If true, and the file extension is insufficient to determine the file type, the (existing) file is opened for further analysis.

imageIFD

private int imageIFD(int no)

openBytes

public byte[] openBytes(int no,
                        byte[] buf,
                        int x,
                        int y,
                        int w,
                        int h)
                 throws FormatException,
                        java.io.IOException

Description copied from interface: IFormatReader

Obtains a sub-image of the specified image plane into a pre-allocated byte array.

Specified by:

openBytes in interface IFormatReader

Overrides:

openBytes in class MinimalTiffReader

Parameters:

no - the plane index within the current series.

buf - a pre-allocated buffer.

x - X coordinate of the upper-left corner of the sub-image

y - Y coordinate of the upper-left corner of the sub-image

w - width of the sub-image

h - height of the sub-image

Returns:

the pre-allocated buffer buf for convenience.

Throws:

FormatException - if there was a problem parsing the metadata of the file.

java.io.IOException - if there was a problem reading the file.

See Also:

IFormatReader.openBytes(int, byte[], int, int, int, int)

openThumbBytes

public byte[] openThumbBytes(int no)
                      throws FormatException,
                             java.io.IOException

Description copied from interface: IFormatReader

Obtains a thumbnail for the specified image plane from the current file, as a byte array.

Specified by:

openThumbBytes in interface IFormatReader

Overrides:

openThumbBytes in class MinimalTiffReader

Throws:

FormatException

java.io.IOException

getThumbSizeX

public int getThumbSizeX()

Description copied from interface: IFormatReader

Get the size of the X dimension for the thumbnail.

Specified by:

getThumbSizeX in interface IFormatReader

Overrides:

getThumbSizeX in class MinimalTiffReader

getThumbSizeY

public int getThumbSizeY()

Description copied from interface: IFormatReader

Get the size of the Y dimension for the thumbnail.

Specified by:

getThumbSizeY in interface IFormatReader

Overrides:

getThumbSizeY in class MinimalTiffReader

close

public void close(boolean fileOnly)
           throws java.io.IOException

Description copied from interface: IFormatReader

Closes the currently open file. If the flag is set, this is all that happens; if unset, it is equivalent to calling Closeable.close().

Specified by:

close in interface IFormatReader

Overrides:

close in class MinimalTiffReader

Throws:

java.io.IOException

getOptimalTileWidth

public int getOptimalTileWidth()

Description copied from interface: IFormatReader

Returns the optimal sub-image width for use with openBytes.

Specified by:

getOptimalTileWidth in interface IFormatReader

Overrides:

getOptimalTileWidth in class MinimalTiffReader

getOptimalTileHeight

public int getOptimalTileHeight()

Description copied from interface: IFormatReader

Returns the optimal sub-image height for use with openBytes.

Specified by:

getOptimalTileHeight in interface IFormatReader

Overrides:

getOptimalTileHeight in class MinimalTiffReader

initTiffParser

protected void initTiffParser()

Description copied from class: MinimalTiffReader

Reinitialize the underlying TiffParser.

Overrides:

initTiffParser in class MinimalTiffReader

initCoreMetadata

protected void initCoreMetadata(int series,
                                int resolution)
                         throws FormatException,
                                java.io.IOException

Throws:

FormatException

java.io.IOException

initStandardMetadata

protected void initStandardMetadata()
                             throws FormatException,
                                    java.io.IOException

Description copied from class: BaseTiffReader

Parses standard metadata. NOTE: Absolutely no calls to the metadata store should be made in this method or methods that override this method. Data will be overwritten if you do so.

Overrides:

initStandardMetadata in class BaseTiffReader

Throws:

FormatException

java.io.IOException

initMetadataStore

protected void initMetadataStore()
                          throws FormatException

Description copied from class: BaseTiffReader

Populates the metadata store using the data parsed in BaseTiffReader.initStandardMetadata() along with some further parsing done in the method itself. All calls to the active MetadataStore should be made in this method and only in this method. This is especially important for sub-classes that override the getters for pixel set array size, etc.

Overrides:

initMetadataStore in class BaseTiffReader

Throws:

FormatException

getParent

private int getParent(int coreIndex)