loci.formats.in

Class PerkinElmerReader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.in.PerkinElmerReader

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatReader, IMetadataConfigurable

public class PerkinElmerReader
extends FormatReader

PerkinElmerReader is the file format reader for PerkinElmer files.

Author:

Melissa Linkert melissa at glencoesoftware.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	PerkinElmerReader.PixelsFile

Field Summary

Fields

Modifier and Type	Field and Description
private Vector<String>	allFiles List of all files to open
static String[]	ANO_SUFFIX
static String[]	CFG_SUFFIX
static String[]	CSV_SUFFIX
static String	DATE_FORMAT
private String	details
private int	extCount
protected PerkinElmerReader.PixelsFile[]	files List of files to open.
private String	finishTime
static String[]	HTM_SUFFIX
static String	HTML_REGEX
private boolean	isTiff Flag indicating that the image data is in TIFF format.
private double	originX
private double	originY
private double	originZ
private double	pixelSizeX
private double	pixelSizeY
static String[]	REC_SUFFIX
private String	sliceSpace
private String	startTime
protected MinimalTiffReader	tiff Helper reader.
static String[]	TIM_SUFFIX
static String[]	ZPO_SUFFIX

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, LOGGER, suffixes

Fields inherited from interface loci.formats.IFormatReader

CAN_GROUP, CANNOT_GROUP, MUST_GROUP

Constructor Summary

Constructors

Constructor and Description
PerkinElmerReader() Constructs a new PerkinElmer reader.

Method Summary

Methods

Modifier and Type	Method and Description
private void	addUsedFile(String workingDirPath, String file) Add the given file to the used files list.
void	close(boolean fileOnly) Closes the currently open file.
int	fileGroupOption(String id) Returns an int indicating that we cannot, must, or might group the files in a given dataset.
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.
private String	getFile(int no)
private int	getFileIndex(int no)
int	getOptimalTileHeight() Returns the optimal sub-image height for use with openBytes.
int	getOptimalTileWidth() Returns the optimal sub-image width for use with openBytes.
String[]	getSeriesUsedFiles(boolean noPixels) Returns an array of filenames needed to open the current series.
protected void	initFile(String id) Initializes the given file (parsing header information, etc.).
boolean	isSingleFile(String id) Returns true if this is a single-file format.
boolean	isThisType(String name, boolean open) Checks if a file matches the type of this format reader.
private PerkinElmerReader.PixelsFile	lookupFile(int no)
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	parseCSVFile(String csvFile)
private void	parseKeyValue(String key, String value)
private void	parseTimFile(String timFile)
private void	parseZpoFile(String zpoFile)

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, 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, getSizeC, getSizeT, getSizeX, getSizeY, getSizeZ, getSupportedMetadataLevels, getThumbSizeX, getThumbSizeY, getUnderlyingReaders, getUsedFiles, getUsedFiles, getZCTCoords, getZCTModuloCoords, hasCompanionFiles, hasFlattenedResolutions, isFalseColor, isGroupFiles, isIndexed, isInterleaved, isInterleaved, isLittleEndian, isMetadataComplete, isMetadataFiltered, isNormalized, isOrderCertain, isOriginalMetadataPopulated, isRGB, isThisType, isThisType, isThisType, isThumbnailSeries, isUsedFile, makeFilterMetadata, openBytes, openBytes, openBytes, openPlane, openThumbBytes, readPlane, readPlane, reopenFile, 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

CFG_SUFFIX

public static final String[] CFG_SUFFIX

ANO_SUFFIX

public static final String[] ANO_SUFFIX

REC_SUFFIX

public static final String[] REC_SUFFIX

TIM_SUFFIX

public static final String[] TIM_SUFFIX

CSV_SUFFIX

public static final String[] CSV_SUFFIX

ZPO_SUFFIX

public static final String[] ZPO_SUFFIX

HTM_SUFFIX

public static final String[] HTM_SUFFIX

HTML_REGEX

public static final String HTML_REGEX

See Also:

Constant Field Values

DATE_FORMAT

public static final String DATE_FORMAT

See Also:

Constant Field Values

tiff

protected MinimalTiffReader tiff

Helper reader.

files

protected PerkinElmerReader.PixelsFile[] files

List of files to open.

isTiff

private boolean isTiff

Flag indicating that the image data is in TIFF format.

allFiles

private Vector<String> allFiles

List of all files to open

extCount

private int extCount

details

private String details

sliceSpace

private String sliceSpace

pixelSizeX

private double pixelSizeX

pixelSizeY

private double pixelSizeY

finishTime

private String finishTime

startTime

private String startTime

originX

private double originX

originY

private double originY

originZ

private double originZ

Constructor Detail

PerkinElmerReader

public PerkinElmerReader()

Constructs a new PerkinElmer reader.

Method Detail

isSingleFile

public boolean isSingleFile(String id)
                     throws FormatException,
                            IOException

Description copied from interface: IFormatReader

Returns true if this is a single-file format.

Specified by:

isSingleFile in interface IFormatReader

Overrides:

isSingleFile in class FormatReader

Throws:

FormatException

IOException

isThisType

public boolean isThisType(String name,
                 boolean open)

Description copied from class: FormatReader

Checks if a file matches the type of this format reader. Checks filename suffixes against those known for this format. If the suffix check is inconclusive and the open parameter is true, the file is opened and tested with FormatReader.isThisType(RandomAccessInputStream).

Specified by:

isThisType in interface IFormatReader

Overrides:

isThisType in class FormatReader

open - If true, and the file extension is insufficient to determine the file type, the (existing) file is opened for further analysis.

fileGroupOption

public int fileGroupOption(String id)
                    throws FormatException,
                           IOException

Description copied from interface: IFormatReader

Returns an int indicating that we cannot, must, or might group the files in a given dataset.

Specified by:

fileGroupOption in interface IFormatReader

Overrides:

fileGroupOption in class FormatReader

Throws:

FormatException

IOException

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 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

Throws:

FormatException

IOException

get16BitLookupTable

public short[][] get16BitLookupTable()
                              throws FormatException,
                                     IOException

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

Throws:

FormatException

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

Specified by:

openBytes in class FormatReader

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)

getSeriesUsedFiles

public 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.

Specified by:

getSeriesUsedFiles in interface IFormatReader

Overrides:

getSeriesUsedFiles in class FormatReader

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 FormatReader

Throws:

IOException

getOptimalTileWidth

public int getOptimalTileWidth()

Description copied from interface: IFormatReader

Returns the optimal sub-image width for use with openBytes.

Specified by:

getOptimalTileWidth in interface IFormatReader

Overrides:

getOptimalTileWidth in class FormatReader

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

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 - if a parsing error occurs processing the file.

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

lookupFile

private PerkinElmerReader.PixelsFile lookupFile(int no)

getFile

private String getFile(int no)

getFileIndex

private int getFileIndex(int no)

parseKeyValue

private void parseKeyValue(String key,
                 String value)

addUsedFile

private void addUsedFile(String workingDirPath,
               String file)

Add the given file to the used files list.

parseTimFile

private void parseTimFile(String timFile)
                   throws IOException

Throws:

IOException

parseCSVFile

private void parseCSVFile(String csvFile)
                   throws IOException

Throws:

IOException

parseZpoFile

private void parseZpoFile(String zpoFile)
                   throws IOException

Throws:

IOException