loci.formats.in
Class ImarisTiffReader

java.lang.Object
  extended by loci.formats.FormatHandler
      extended by loci.formats.FormatReader
          extended by loci.formats.in.BaseTiffReader
              extended by loci.formats.in.ImarisTiffReader
All Implemented Interfaces:
IFormatHandler, IFormatReader, StatusReporter

public class ImarisTiffReader
extends BaseTiffReader

ImarisTiffReader is the file format reader for Imaris 5 files (TIFF variant).

Source code:
Trac, SVN

Author:
Melissa Linkert linkert at wisc.edu

Field Summary
 
Fields inherited from class loci.formats.in.BaseTiffReader
ifds
 
Fields inherited from class loci.formats.FormatReader
collectMetadata, core, filterMetadata, group, in, metadata, metadataStore, normalizeData, saveOriginalMetadata, series, THUMBNAIL_DIMENSION
 
Fields inherited from class loci.formats.FormatHandler
currentId, debug, debugLevel, format, statusListeners, suffixes
 
Fields inherited from interface loci.formats.IFormatReader
CAN_GROUP, CANNOT_GROUP, MUST_GROUP
 
Constructor Summary
ImarisTiffReader()
          Constructs a new Imaris TIFF reader.
 
Method Summary
protected  void initFile(String id)
          Initializes the given file (parsing header information, etc.).
 boolean isThisType(byte[] block)
          Checks if the given block is a valid header for this file format.
 boolean isThisType(String name, boolean open)
          Checks if a file matches the type of this format handler.
 
Methods inherited from class loci.formats.in.BaseTiffReader
get16BitLookupTable, get8BitLookupTable, getImageCreationDate, getImageDescription, getImageName, getMetadataValue, getTiffDimensions, initMetadata, initMetadataStore, initStandardMetadata, openBytes, put, put, put, put, put, put, put, put, put, put, putInt, swapIfRequired
 
Methods inherited from class loci.formats.FormatReader
addMeta, checkBytes, close, close, fileGroupOption, getChannelDimLengths, getChannelDimLengths, getChannelDimTypes, getChannelDimTypes, getCoreMetadata, getCoreMetadata, getCurrentFile, getDimensionOrder, getDimensionOrder, getEffectiveSizeC, getEffectiveSizeC, getImageCount, getImageCount, getIndex, getIndex, getMeta, getMetadata, getMetadata, getMetadataStore, getMetadataStore, getMetadataStoreRoot, getMetadataStoreRoot, getMetadataValue, getPixelType, getPixelType, getRGBChannelCount, getRGBChannelCount, getSeries, getSeries, getSeriesCount, getSeriesCount, getSizeC, getSizeC, getSizeT, getSizeT, getSizeX, getSizeX, getSizeY, getSizeY, getSizeZ, getSizeZ, getThumbSizeX, getThumbSizeX, getThumbSizeY, getThumbSizeY, getUsedFiles, getUsedFiles, getZCTCoords, getZCTCoords, isFalseColor, isGroupFiles, isIndexed, isInterleaved, isInterleaved, isInterleaved, isInterleaved, isLittleEndian, isLittleEndian, isMetadataCollected, isMetadataComplete, isMetadataFiltered, isNormalized, isOrderCertain, isOrderCertain, isOriginalMetadataPopulated, isRGB, isRGB, isUsedFile, openBytes, openBytes, openBytes, openImage, openImage, openThumbBytes, openThumbBytes, openThumbImage, openThumbImage, setGroupFiles, setId, setMetadataCollected, setMetadataFiltered, setMetadataStore, setNormalized, setOriginalMetadataPopulated, setSeries, setSeries
 
Methods inherited from class loci.formats.FormatHandler
addStatusListener, debug, getFormat, getStatusListeners, getSuffixes, isThisType, removeStatusListener, setDebug, setDebugLevel, setId, status, status, status, trace, trace
 
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, getSuffixes, isThisType, setId
 
Methods inherited from interface loci.formats.StatusReporter
addStatusListener, getStatusListeners, removeStatusListener
 

Constructor Detail

ImarisTiffReader

public ImarisTiffReader()
Constructs a new Imaris TIFF reader.

Method Detail

isThisType

public boolean isThisType(byte[] block)
Description copied from interface: IFormatReader
Checks if the given block is a valid header for this file format.

Specified by:
isThisType in interface IFormatReader
Overrides:
isThisType in class BaseTiffReader

isThisType

public boolean isThisType(String name,
                          boolean open)
Description copied from class: FormatHandler
Checks if a file matches the type of this format handler. The default implementation checks filename suffixes against those known for this format (the open parameter does nothing).

Specified by:
isThisType in interface IFormatHandler
Overrides:
isThisType in class FormatHandler
open - If true, and the file extension is insufficient to determine the file type, the (existing) file is opened for further analysis. Does nothing in the default implementation.

initFile

protected void initFile(String id)
                 throws FormatException,
                        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 BaseTiffReader
Throws:
FormatException
IOException