loci.formats.in

Class InCellReader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.in.InCellReader

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatReader, IMetadataConfigurable

public class InCellReader
extends FormatReader

InCellReader is the file format reader for InCell 1000/2000 datasets.

Author:

Melissa Linkert melissa at glencoesoftware.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	InCellReader.Image
(package private) class	InCellReader.InCellHandler SAX handler for parsing XML.
(package private) class	InCellReader.MinimalInCellHandler

Field Summary

Fields

Modifier and Type	Field and Description
private Binning	bin
private List<String>	channelNames
private List<Integer>	channelsPerTimepoint
private String	colName
private String	creationDate
static String	CYTELL_MAGIC_STRING
private List<Double>	emWaves
private boolean[][]	exclude
private List<Double>	exWaves
private int	fieldCount
private Double	gain
private InCellReader.Image[][][][]	imageFiles
private int	imageHeight
private int	imageWidth
static String	INCELL_MAGIC_STRING
private static String[]	METADATA_SUFFIXES
private List<String>	metadataFiles
private boolean	oneTimepointPerSeries
private static String[]	PIXELS_SUFFIXES
private boolean[][]	plateMap
private List<Length>	posX
private List<Length>	posY
private Double	refractive
private String	rowName
private Double	temperature
private MinimalTiffReader	tiffReader
private int	totalChannels
private int	totalImages
private int	wellCols
private Map<Integer,int[]>	wellCoordinates
private int	wellRows
private Length	x
private Length	y

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
InCellReader() Constructs a new InCell 1000/2000 reader.

Method Summary

Methods

Modifier and Type	Method and Description
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 int	getFieldFromSeries(int series)
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.
private int	getWellFromSeries(int 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(RandomAccessInputStream stream) Checks if the given stream is a valid stream for this file format.
boolean	isThisType(String name, boolean open) Checks if a file matches the type of this format reader.
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.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, 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

INCELL_MAGIC_STRING

public static final String INCELL_MAGIC_STRING

See Also:

Constant Field Values

CYTELL_MAGIC_STRING

public static final String CYTELL_MAGIC_STRING

See Also:

Constant Field Values

PIXELS_SUFFIXES

private static final String[] PIXELS_SUFFIXES

METADATA_SUFFIXES

private static final String[] METADATA_SUFFIXES

plateMap

private boolean[][] plateMap

imageFiles

private InCellReader.Image[][][][] imageFiles

tiffReader

private MinimalTiffReader tiffReader

emWaves

private List<Double> emWaves

exWaves

private List<Double> exWaves

channelNames

private List<String> channelNames

totalImages

private int totalImages

imageWidth

private int imageWidth

imageHeight

private int imageHeight

creationDate

private String creationDate

rowName

private String rowName

colName

private String colName

fieldCount

private int fieldCount

wellRows

private int wellRows

wellCols

private int wellCols

wellCoordinates

private Map<Integer,int[]> wellCoordinates

posX

private List<Length> posX

posY

private List<Length> posY

exclude

private boolean[][] exclude

channelsPerTimepoint

private List<Integer> channelsPerTimepoint

oneTimepointPerSeries

private boolean oneTimepointPerSeries

totalChannels

private int totalChannels

metadataFiles

private List<String> metadataFiles

bin

private Binning bin

x

private Length x

y

private Length y

gain

private Double gain

temperature

private Double temperature

refractive

private Double refractive

Constructor Detail

InCellReader

public InCellReader()

Constructs a new InCell 1000/2000 reader.

Method Detail

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.

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

Throws:

IOException

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

getFieldFromSeries

private int getFieldFromSeries(int series)

getWellFromSeries

private int getWellFromSeries(int series)