loci.formats.in

Class LOFReader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.in.LeicaMicrosystemsMetadata.LMSFileReader

loci.formats.in.LOFReader

All Implemented Interfaces:

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

public class LOFReader
extends LMSFileReader

LOFReader is the file format reader for Leica Microsystems' LOF files.

Author:

Melissa Linkert melissa at glencoesoftware.com, Constanze Wendlandt constanze.wendlandt at leica-microsystems.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LOFReader.MetadataSource

Nested classes/interfaces inherited from class loci.formats.in.LeicaMicrosystemsMetadata.LMSFileReader

LMSFileReader.ImageFormat

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ENCODING The encoding used in this file.
private long	endPointer
private int	lastChannel
static byte	LOF_MAGIC_BYTE
static byte	LOF_MEMORY_BYTE
private LOFReader.MetadataSource	metadataSource
private java.util.List<java.lang.Long>	offsets Offsets to memory blocks, paired with their corresponding description.

Fields inherited from class loci.formats.in.LeicaMicrosystemsMetadata.LMSFileReader

associatedXmlDoc, log, metaTemp, OLD_PHYSICAL_SIZE_DEFAULT, OLD_PHYSICAL_SIZE_KEY

Fields inherited from class loci.formats.FormatReader

core, coreIndex, datasetDescription, domains, fillColor, 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, LOGGER, metadataOptions, suffixes

Fields inherited from interface loci.formats.IFormatReader

CAN_GROUP, CANNOT_GROUP, MUST_GROUP

Constructor Summary

Constructors

Constructor and Description
LOFReader() Constructs a new Leica LOF reader.
LOFReader(XlifDocument xlif)

Method Summary

Modifier and Type	Method and Description
private void	checkForLofLayout(loci.common.RandomAccessInputStream in, java.lang.String filename) Checks if file layout meets lof file specifications
void	close(boolean fileOnly) Closes the currently open file.
short[][]	get16BitLookupTable() Gets the 16-bit color lookup table associated with the most recently opened image.
byte[][]	get8BitLookupTable() Gets the 8-bit color lookup table associated with the most recently opened image.
LMSFileReader.ImageFormat	getImageFormat() Returns the file format in which actual image bytes are stored
int	getOptimalTileHeight() Returns the optimal sub-image height for use with openBytes.
java.lang.String[]	getSeriesUsedFiles(boolean noPixels) Returns an array of filenames needed to open the current series.
private int	getTileIndex(int coreIndex)
protected void	initFile(java.lang.String id) Initializes the given file (parsing header information, etc.).
boolean	isThisType(loci.common.RandomAccessInputStream stream) Checks if the given stream is a valid stream for this file format.
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.
private void	seekStartOfPlane(int no, long dataOffset, long planeSize)
void	setIdWithMetadata(java.lang.String id, XlifDocument xml) Inits the LOFReader using passed xml (from XLIF) for metadata initiation, instead of reading the LOF's included xml

Methods inherited from class loci.formats.in.LeicaMicrosystemsMetadata.LMSFileReader

addSeriesMeta, addSeriesMetaList, fileExists, getCore, makeFilterMetadata, setCore, translateMetadata, translateMetadata, useOldPhysicalSizeCalculation

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, close, coreIndexToSeries, fileGroupOption, flattenHashtables, getAcquisitionMode, getAdvancedSeriesUsedFiles, getAdvancedUsedFiles, getArcType, getAvailableOptions, getBinning, getBitsPerPixel, getCompression, getContrastMethod, getCoreIndex, getCoreMetadataList, getCorrection, getCurrentCore, getCurrentFile, getDatasetStructureDescription, getDetectorType, getDimensionOrder, getDimensionOrder, getDomains, getEffectiveSizeC, getExperimentType, getFilamentType, getFillColor, getFillRule, getFilterType, getFontFamily, getFontStyle, getGlobalMeta, getGlobalMetadata, getIlluminationType, getImageCount, getImmersion, getIndex, getIndex, getLaserMedium, getLaserType, getMarker, getMedium, getMetadataStore, getMetadataStoreRoot, getMetadataValue, getMicrobeamManipulationType, getMicroscopeType, getModuloC, getModuloT, getModuloZ, getNamingConvention, getOptimalTileWidth, getPixelType, getPixelType, getPossibleDomains, getPulse, getRequiredDirectories, getResolution, getResolutionCount, getRGBChannelCount, getRotationTransform, getSeries, getSeriesCount, getSeriesMeta, getSeriesMetadata, getSeriesMetadataValue, getSeriesUsedFiles, getSizeC, getSizeT, getSizeX, getSizeY, getSizeZ, getThumbSizeX, getThumbSizeY, getTileColumns, getTileRows, getUnderlyingReaders, getUsedFiles, getUsedFiles, getZCTCoords, getZCTModuloCoords, hasCompanionFiles, hasFlattenedResolutions, isFalseColor, isGroupFiles, isIndexed, isInterleaved, isInterleaved, isLittleEndian, isMetadataComplete, isMetadataFiltered, isNormalized, isOrderCertain, isOriginalMetadataPopulated, isRGB, isSingleFile, isThisType, isThisType, isThisType, isThumbnailSeries, isUsedFile, openBytes, openBytes, openBytes, openPlane, openThumbBytes, readPlane, readPlane, readPlane, reopenFile, seriesToCoreIndex, setCoreIndex, setFillColor, setFlattenedResolutions, setGroupFiles, setId, setMetadataFiltered, setMetadataStore, setNormalized, setOriginalMetadataPopulated, setResolution, setSeries, 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

Methods inherited from interface loci.formats.ICompressedTileReader

getTileCodec, getTileCodecOptions, openCompressedBytes, openCompressedBytes

Field Detail

LOF_MAGIC_BYTE

public static final byte LOF_MAGIC_BYTE

See Also:

Constant Field Values

LOF_MEMORY_BYTE

public static final byte LOF_MEMORY_BYTE

See Also:

Constant Field Values

ENCODING

private static final java.lang.String ENCODING

The encoding used in this file.

See Also:

Constant Field Values

offsets

private java.util.List<java.lang.Long> offsets

Offsets to memory blocks, paired with their corresponding description.

lastChannel

private int lastChannel

endPointer

private long endPointer

metadataSource

private LOFReader.MetadataSource metadataSource

Constructor Detail

LOFReader

public LOFReader()

Constructs a new Leica LOF reader.

LOFReader

public LOFReader(XlifDocument xlif)

Method Detail

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 FormatReader

isThisType

public boolean isThisType(loci.common.RandomAccessInputStream stream)
                   throws java.io.IOException

Description copied from interface: IFormatReader

Checks if the given stream is a valid stream for this file format. The number of bytes read is format-dependent.

Specified by:

isThisType in interface IFormatReader

Overrides:

isThisType in class FormatReader

Parameters:

stream - A RandomAccessInputStream representing the file to check. The first byte in the stream is assumed to be the first byte in the file.

Returns:

true if the file represented by the stream can be read by this reader; false otherwise.

Throws:

java.io.IOException

get8BitLookupTable

public byte[][] get8BitLookupTable()

Description copied from interface: IFormatReader

Gets the 8-bit color lookup table associated with the most recently opened image. If no image planes have been opened, or if IFormatReader.isIndexed() returns false, then this may return null. Also, if IFormatReader.getPixelType() returns anything other than FormatTools.INT8 or FormatTools.UINT8, this method will return null.

Specified by:

get8BitLookupTable in interface IFormatReader

Overrides:

get8BitLookupTable in class FormatReader

get16BitLookupTable

public short[][] get16BitLookupTable()

Description copied from interface: IFormatReader

Gets the 16-bit color lookup table associated with the most recently opened image. If no image planes have been opened, or if IFormatReader.isIndexed() returns false, then this may return null. Also, if IFormatReader.getPixelType() returns anything other than FormatTools.INT16 or FormatTools.UINT16, this method will return null.

Specified by:

get16BitLookupTable in interface IFormatReader

Overrides:

get16BitLookupTable in class FormatReader

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

Specified by:

openBytes in class FormatReader

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)

getSeriesUsedFiles

public java.lang.String[] getSeriesUsedFiles(boolean noPixels)

Description copied from interface: IFormatReader

Returns an array of filenames needed to open the current series. If the 'noPixels' flag is set, then only files that do not contain pixel data will be returned. The first element in the array is expected to be the path passed to IFormatHandler.setId(String), if appropriate based upon 'noPixels'. The remaining elements are expected to be in a consistent order; if a directory listing is necessary to build the list then it should be sorted first.

Specified by:

getSeriesUsedFiles in interface IFormatReader

Overrides:

getSeriesUsedFiles in class FormatReader

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 LMSFileReader

Throws:

java.io.IOException

initFile

protected void initFile(java.lang.String id)
                 throws FormatException,
                        java.io.IOException

Description copied from class: FormatReader

Initializes the given file (parsing header information, etc.). Most subclasses should override this method to perform initialization operations such as parsing metadata.

Overrides:

initFile in class FormatReader

Throws:

FormatException - if a parsing error occurs processing the file.

java.io.IOException - if an I/O error occurs processing the file

getImageFormat

public LMSFileReader.ImageFormat getImageFormat()

Description copied from class: LMSFileReader

Returns the file format in which actual image bytes are stored

Specified by:

getImageFormat in class LMSFileReader

checkForLofLayout

private void checkForLofLayout(loci.common.RandomAccessInputStream in,
                               java.lang.String filename)
                        throws FormatException,
                               java.io.IOException

Checks if file layout meets lof file specifications

Parameters:

in - lof file stream

filename - name of the lof file

Throws:

FormatException

java.io.IOException

seekStartOfPlane

private void seekStartOfPlane(int no,
                              long dataOffset,
                              long planeSize)
                       throws java.io.IOException

Throws:

java.io.IOException

getTileIndex

private int getTileIndex(int coreIndex)

setIdWithMetadata

public void setIdWithMetadata(java.lang.String id,
                              XlifDocument xml)
                       throws FormatException,
                              java.io.IOException

Inits the LOFReader using passed xml (from XLIF) for metadata initiation, instead of reading the LOF's included xml

Parameters:

id - LOF file id

xml - XML from xlif that points to LOF file

Throws:

FormatException

java.io.IOException