loci.formats.in
Class AVIReader

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

public class AVIReader
extends FormatReader

AVIReader is the file format reader for AVI files. Much of this code was adapted from Wayne Rasband's AVI Movie Reader plugin for ImageJ (available at http://rsb.info.nih.gov/ij).

Source code:
Trac, SVN


Field Summary
 
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
AVIReader()
          Constructs a new AVI reader.
 
Method Summary
 byte[][] get8BitLookupTable()
          Gets the 8-bit color lookup table associated with the most recently opened image.
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.
 byte[] openBytes(int no, byte[] buf)
          Obtains the specified image from the current file into a pre-allocated byte array of (sizeX * sizeY * bytesPerPixel).
 
Methods inherited from class loci.formats.FormatReader
addMeta, checkBytes, close, close, fileGroupOption, get16BitLookupTable, getChannelDimLengths, getChannelDimLengths, getChannelDimTypes, getChannelDimTypes, getCoreMetadata, getCoreMetadata, getCurrentFile, getDimensionOrder, getDimensionOrder, getEffectiveSizeC, getEffectiveSizeC, getImageCount, getImageCount, getIndex, getIndex, getMeta, getMetadata, getMetadata, getMetadataStore, getMetadataStore, getMetadataStoreRoot, getMetadataStoreRoot, getMetadataValue, 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, 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, isThisType, setId
 
Methods inherited from interface loci.formats.StatusReporter
addStatusListener, getStatusListeners, removeStatusListener
 

Constructor Detail

AVIReader

public AVIReader()
Constructs a new AVI 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.


get8BitLookupTable

public byte[][] get8BitLookupTable()
                            throws FormatException,
                                   IOException
Description copied from interface: IFormatReader
Gets the 8-bit color lookup table associated with the most recently opened image. If no images have been opened, or if isIndexed() returns false, then this returns null. Also, if getPixelType() returns anything other than INT8 or UINT8, this method will return null.

Specified by:
get8BitLookupTable in interface IFormatReader
Overrides:
get8BitLookupTable in class FormatReader
Throws:
FormatException
IOException

openBytes

public byte[] openBytes(int no,
                        byte[] buf)
                 throws FormatException,
                        IOException
Description copied from interface: IFormatReader
Obtains the specified image from the current file into a pre-allocated byte array of (sizeX * sizeY * bytesPerPixel).

Parameters:
no - the image index within the file.
buf - a pre-allocated buffer.
Returns:
the pre-allocated buffer buf for convenience.
Throws:
FormatException - if there was a problem parsing the metadata of the file.
IOException - if there was a problem reading the file.

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 FormatReader
Throws:
FormatException
IOException