Package loci.formats.in
Class FluoviewReader
- All Implemented Interfaces:
Closeable,AutoCloseable,ICompressedTileReader,IFormatHandler,IFormatReader,IMetadataConfigurable,IPyramidHandler
FluoviewReader is the file format reader for
Olympus Fluoview TIFF files AND Andor Bio-imaging Division (ABD) TIFF files.
- Author:
- Eric Kjellman egkjellman at wisc.edu, Melissa Linkert melissa at glencoesoftware.com, Curtis Rueden ctrueden at wisc.edu
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final intprivate static final intprivate static final Stringprivate static final intprivate static final intprivate static final intprivate String[]private static final intprivate static final intprivate static final intprivate Stringprivate static final intprivate Stringprivate static final StringDate formatprivate Stringprivate Stringprivate static final intprivate static final intprivate Floatprivate intprivate double[][]private static final StringString identifying a Fluoview file.private String[]private static final intprivate static final intprivate String[]private Stringprivate static final intPrivate TIFF tagsprivate static final intprivate Stringprivate static final intprivate intprivate double[][]private static final intprivate static final intprivate Stringprivate String[]private static final intprivate static final intprivate static final intprivate Floatprivate double[][]Timestamps for each plane, in seconds.private Floatprivate static final intprivate intprivate static final intprivate static final intprivate static final intprivate String[]private doublePixel dimensions for this file.private doublePixel dimensions for this file.private doublePixel dimensions for this file.private doublePixel dimensions for this file.private doublePixel dimensions for this file.private double[]Fields inherited from class loci.formats.in.BaseTiffReader
DATE_FORMATS, LOGGERFields inherited from class loci.formats.in.MinimalTiffReader
canSeparateSeries, equalStrips, ifds, lastPlane, mergeSubIFDs, noSubresolutions, seriesToIFD, subResolutionIFDs, thumbnailIFDs, tiffParser, use64BitFields inherited from class loci.formats.SubResolutionFormatReader
coreFields inherited from class loci.formats.FormatReader
coreIndex, datasetDescription, domains, fillColor, filterMetadata, flattenedResolutions, group, hasCompanionFiles, in, indexedAsRGB, metadata, metadataStore, normalizeData, resolution, saveOriginalMetadata, series, suffixNecessary, suffixSufficient, THUMBNAIL_DIMENSIONFields inherited from class loci.formats.FormatHandler
COMPRESSION_SUFFIXES, currentId, format, metadataOptions, suffixesFields inherited from interface loci.formats.IFormatReader
CAN_GROUP, CANNOT_GROUP, MUST_GROUP -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose(boolean fileOnly) Closes the currently open file.private intgetField(int seriesIndex) private intgetImageIndex(int no) private intgetMontage(int seriesIndex) private int[]getPos(int seriesIndex) private voidprivate voidprotected voidPopulates the metadata store using the data parsed inBaseTiffReader.initStandardMetadata()along with some further parsing done in the method itself.protected voidParses standard metadata.booleanisThisType(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 voidprivate voidprivate voidprivate byte[]shortArrayToBytes(short[] s) Methods inherited from class loci.formats.in.BaseTiffReader
getExifTagName, getImageCreationDate, initFile, initMetadata, put, put, put, put, put, put, put, put, put, put, putDouble, putInt, putStringMethods inherited from class loci.formats.in.MinimalTiffReader
copyTile, get16BitLookupTable, get8BitLookupTable, getCompressedByteCount, getIFDs, getOptimalTileHeight, getOptimalTileWidth, getThumbnailIFDs, getThumbSizeX, getThumbSizeY, getTileIndex, initTiffParser, openThumbBytes, reopenFile, setResolutionLevelMethods inherited from class loci.formats.SubResolutionFormatReader
coreIndexToSeries, flattenHashtables, getCoreIndex, getCoreMetadataList, getCurrentCore, getResolution, getResolutionCount, getSeries, getSeriesCount, seriesToCoreIndex, setCoreIndex, setResolution, setSeriesMethods 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, 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, getPixelType, getPixelType, getPossibleDomains, getPulse, getRequiredDirectories, getRGBChannelCount, getRotationTransform, getSeriesMeta, getSeriesMetadata, getSeriesMetadataValue, getSeriesUsedFiles, getSeriesUsedFiles, getSizeC, getSizeT, getSizeX, getSizeY, getSizeZ, 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, makeFilterMetadata, openBytes, openBytes, openBytes, openPlane, readPlane, readPlane, readPlane, setFillColor, setFlattenedResolutions, setGroupFiles, setId, setMetadataFiltered, setMetadataStore, setNormalized, setOriginalMetadataPopulated, updateMetadataListsMethods inherited from class loci.formats.FormatHandler
checkSuffix, checkSuffix, getFormat, getMetadataOptions, getNativeDataType, getSuffixes, getSupportedMetadataLevels, setMetadataOptionsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface loci.formats.ICompressedTileReader
getTileCodec, getTileCodecOptions, openCompressedBytes, openCompressedBytesMethods inherited from interface loci.formats.IFormatHandler
getFormat, getNativeDataType, getSuffixesMethods inherited from interface loci.formats.IMetadataConfigurable
getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions
-
Field Details
-
FLUOVIEW_MAGIC_STRING
String identifying a Fluoview file.- See Also:
-
ANDOR_MAGIC_STRING
- See Also:
-
MMHEADER
private static final int MMHEADERPrivate TIFF tags- See Also:
-
MMSTAMP
private static final int MMSTAMP- See Also:
-
TEMPERATURE
private static final int TEMPERATURE- See Also:
-
EXPOSURE_TIME
private static final int EXPOSURE_TIME- See Also:
-
KINETIC_CYCLE_TIME
private static final int KINETIC_CYCLE_TIME- See Also:
-
N_ACCUMULATIONS
private static final int N_ACCUMULATIONS- See Also:
-
ACQUISITION_CYCLE_TIME
private static final int ACQUISITION_CYCLE_TIME- See Also:
-
READOUT_TIME
private static final int READOUT_TIME- See Also:
-
EM_DAC
private static final int EM_DAC- See Also:
-
N_FRAMES
private static final int N_FRAMES- See Also:
-
HORIZONTAL_FLIP
private static final int HORIZONTAL_FLIP- See Also:
-
VERTICAL_FLIP
private static final int VERTICAL_FLIP- See Also:
-
CLOCKWISE
private static final int CLOCKWISE- See Also:
-
COUNTER_CLOCKWISE
private static final int COUNTER_CLOCKWISE- See Also:
-
VERTICAL_CLOCK_VOLTAGE
private static final int VERTICAL_CLOCK_VOLTAGE- See Also:
-
VERTICAL_SHIFT_SPEED
private static final int VERTICAL_SHIFT_SPEED- See Also:
-
PRE_AMP_SETTING
private static final int PRE_AMP_SETTING- See Also:
-
CAMERA_SERIAL_SETTING
private static final int CAMERA_SERIAL_SETTING- See Also:
-
ACTUAL_TEMPERATURE
private static final int ACTUAL_TEMPERATURE- See Also:
-
BASELINE_CLAMP
private static final int BASELINE_CLAMP- See Also:
-
PRESCANS
private static final int PRESCANS- See Also:
-
MODEL
private static final int MODEL- See Also:
-
CHIP_SIZE_X
private static final int CHIP_SIZE_X- See Also:
-
CHIP_SIZE_Y
private static final int CHIP_SIZE_Y- See Also:
-
BASELINE_OFFSET
private static final int BASELINE_OFFSET- See Also:
-
DATE_FORMAT
Date format- See Also:
-
voxelX
private double voxelXPixel dimensions for this file. -
voxelY
private double voxelYPixel dimensions for this file. -
voxelZ
private double voxelZPixel dimensions for this file. -
voxelC
private double voxelCPixel dimensions for this file. -
voxelT
private double voxelTPixel dimensions for this file. -
dimensionOrder
-
date
-
timeIndex
private int timeIndex -
fieldIndex
private int fieldIndex -
montageIndex
private int montageIndex -
stamps
private double[][] stampsTimestamps for each plane, in seconds. -
zPositions
private double[] zPositions -
gains
-
voltages
-
offsets
-
channelNames
-
lensNA
-
mag
-
detectorManufacturer
-
objectiveManufacturer
-
comment
-
temperature
-
exposureTime
-
readoutTime
-
model
-
montageOffsets
private double[][] montageOffsets -
fieldOffsets
private double[][] fieldOffsets
-
-
Constructor Details
-
FluoviewReader
public FluoviewReader()Constructs a new Fluoview TIFF reader.
-
-
Method Details
-
isThisType
Description copied from interface:IFormatReaderChecks if the given stream is a valid stream for this file format. The number of bytes read is format-dependent.- Specified by:
isThisTypein interfaceIFormatReader- Overrides:
isThisTypein classMinimalTiffReader- 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:
IOException
-
openBytes
public byte[] openBytes(int no, byte[] buf, int x, int y, int w, int h) throws FormatException, IOException Description copied from interface:IFormatReaderObtains a sub-image of the specified image plane into a pre-allocated byte array.- Specified by:
openBytesin interfaceIFormatReader- Overrides:
openBytesin classMinimalTiffReader- 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-imagey- Y coordinate of the upper-left corner of the sub-imagew- width of the sub-imageh- height of the sub-image- Returns:
- the pre-allocated buffer
buffor convenience. - Throws:
FormatException- if there was a problem parsing the metadata of the file.IOException- if there was a problem reading the file.- See Also:
-
close
Description copied from interface:IFormatReaderCloses the currently open file. If the flag is set, this is all that happens; if unset, it is equivalent to callingCloseable.close().- Specified by:
closein interfaceIFormatReader- Overrides:
closein classMinimalTiffReader- Throws:
IOException
-
initStandardMetadata
Description copied from class:BaseTiffReaderParses 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:
initStandardMetadatain classBaseTiffReader- Throws:
FormatExceptionIOException
-
initMetadataStore
Description copied from class:BaseTiffReaderPopulates the metadata store using the data parsed inBaseTiffReader.initStandardMetadata()along with some further parsing done in the method itself. All calls to the activeMetadataStoreshould 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:
initMetadataStorein classBaseTiffReader- Throws:
FormatException
-
initAlternateMetadata
- Throws:
FormatExceptionIOException
-
initAlternateMetadataStore
- Throws:
FormatException
-
getImageIndex
private int getImageIndex(int no) -
readStamps
- Throws:
FormatExceptionIOException
-
shortArrayToBytes
private byte[] shortArrayToBytes(short[] s) -
parsePageName
private void parsePageName() -
parseComment
private void parseComment() -
getMontage
private int getMontage(int seriesIndex) -
getField
private int getField(int seriesIndex) -
getPos
private int[] getPos(int seriesIndex)
-