loci.formats.in

Class SimplePCITiffReader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.in.MinimalTiffReader

loci.formats.in.BaseTiffReader

loci.formats.in.SimplePCITiffReader

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatReader, IMetadataConfigurable

public class SimplePCITiffReader
extends BaseTiffReader

SimplePCITiffReader is the file format reader for TIFF files produced by SimplePCI software.

Field Summary

Fields

Modifier and Type	Field and Description
private String	binning
private String	cameraName
private String	cameraType
private static int	CUSTOM_BITS
private String	date
private static String	DATE_FORMAT
private MinimalTiffReader	delegate
private ArrayList<Double>	exposureTimes
private String	immersion
private static String	MAGIC_STRING
private Double	magnification
private double	scaling

Fields inherited from class loci.formats.in.BaseTiffReader

DATE_FORMATS, LOGGER

Fields inherited from class loci.formats.in.MinimalTiffReader

equalStrips, ifds, lastPlane, noSubresolutions, subResolutionIFDs, thumbnailIFDs, tiffParser, use64Bit

Fields inherited from class loci.formats.FormatReader

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

Fields inherited from class loci.formats.FormatHandler

COMPRESSION_SUFFIXES, currentId, format, suffixes

Fields inherited from interface loci.formats.IFormatReader

CAN_GROUP, CANNOT_GROUP, MUST_GROUP

Constructor Summary

Constructors

Constructor and Description
SimplePCITiffReader()

Method Summary

Methods

Modifier and Type	Method and Description
void	close(boolean fileOnly) Closes the currently open file.
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.
boolean	isThisType(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.

Methods inherited from class loci.formats.in.BaseTiffReader

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

Methods inherited from class loci.formats.in.MinimalTiffReader

get16BitLookupTable, get8BitLookupTable, getIFDs, getOptimalTileHeight, getOptimalTileWidth, getThumbnailIFDs, getThumbSizeX, getThumbSizeY, initTiffParser, openThumbBytes, reopenFile, setResolutionLevel

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, coreIndexToSeries, fileGroupOption, flattenHashtables, getAcquisitionMode, getAdvancedSeriesUsedFiles, getAdvancedUsedFiles, getArcType, getBinning, getBitsPerPixel, getCompression, getContrastMethod, getCoreIndex, getCoreMetadataList, getCorrection, getCurrentFile, getDatasetStructureDescription, getDetectorType, getDimensionOrder, getDimensionOrder, getDomains, getEffectiveSizeC, getExperimentType, getFilamentType, getFillRule, getFilterType, getFontFamily, getFontStyle, getGlobalMeta, getGlobalMetadata, getIlluminationType, getImageCount, getImmersion, getIndex, getIndex, getLaserMedium, getLaserType, getLineCap, getMarker, getMedium, getMetadataOptions, getMetadataStore, getMetadataStoreRoot, getMetadataValue, getMicrobeamManipulationType, getMicroscopeType, getModuloC, getModuloT, getModuloZ, getNamingConvention, getPixelType, getPixelType, getPossibleDomains, getPulse, getRequiredDirectories, getResolution, getResolutionCount, getRGBChannelCount, getRotationTransform, getSeries, getSeriesCount, getSeriesMeta, getSeriesMetadata, getSeriesMetadataValue, getSeriesUsedFiles, getSeriesUsedFiles, getSizeC, getSizeT, getSizeX, getSizeY, getSizeZ, getSupportedMetadataLevels, 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, seriesToCoreIndex, setCoreIndex, setFlattenedResolutions, setGroupFiles, setId, setMetadataFiltered, setMetadataOptions, setMetadataStore, setNormalized, setOriginalMetadataPopulated, setResolution, setSeries

Methods inherited from class loci.formats.FormatHandler

checkSuffix, checkSuffix, getFormat, getNativeDataType, getSuffixes

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

Field Detail

MAGIC_STRING

private static final String MAGIC_STRING

See Also:

Constant Field Values

DATE_FORMAT

private static final String DATE_FORMAT

See Also:

Constant Field Values

CUSTOM_BITS

private static final int CUSTOM_BITS

See Also:

Constant Field Values

delegate

private MinimalTiffReader delegate

date

private String date

magnification

private Double magnification

immersion

private String immersion

cameraType

private String cameraType

cameraName

private String cameraName

binning

private String binning

exposureTimes

private ArrayList<Double> exposureTimes

scaling

private double scaling

Constructor Detail

SimplePCITiffReader

public SimplePCITiffReader()

Method Detail

isThisType

public boolean isThisType(RandomAccessInputStream stream)
                   throws IOException

Description copied from interface: IFormatReader

Checks if the given stream is a valid stream for this file format.

Specified by:

isThisType in interface IFormatReader

Overrides:

isThisType in class MinimalTiffReader

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: 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 image index within the file.

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.

IOException - if there was a problem reading the file.

See Also:

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

close

public void close(boolean fileOnly)
           throws 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:

IOException

initStandardMetadata

protected void initStandardMetadata()
                             throws FormatException,
                                    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

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