loci.formats.in

Class CellH5Reader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.in.CellH5Reader

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatReader, IMetadataConfigurable

public class CellH5Reader
extends FormatReader

Reader for CellH5 (HDF) files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CellH5Reader.CellH5Constants
class	CellH5Reader.CellH5Coordinate

Field Summary

Fields

Modifier and Type	Field and Description
private ch.systemsx.cisd.hdf5.HDF5CompoundDataMap[]	bbox
private List<String>	CellH5PathsToImageData
private List<CellH5Reader.CellH5Coordinate>	CellH5PositionList
private List<String>	cellObjectNames
private ch.systemsx.cisd.hdf5.HDF5CompoundDataMap[]	classes
private int[][]	COLORS
static String	HDF_MAGIC_STRING
private JHDFService	jhdf
private int	lastChannel
private double	maxX
private double	maxY
private double	maxZ
private double	minX
private double	minY
private double	minZ
private double	pixelSizeX
private double	pixelSizeY
private double	pixelSizeZ
private int	seriesCount
private MetadataStore	store
private ch.systemsx.cisd.hdf5.HDF5CompoundDataMap[]	times

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
CellH5Reader() Constructs a new CellH5 HDF reader.

Method Summary

Methods

Modifier and Type	Method and Description
void	close(boolean fileOnly) Closes the currently open file.
byte[][]	get8BitLookupTable() Gets the 8-bit color lookup table associated with the most recently opened image.
private int	getChannelIndexOfCellObjectName(String cellObjectName)
private Object	getImageData(int no, int y, int height)
int	getOptimalTileHeight() Returns the optimal sub-image height for use with openBytes.
private static Color	hex2Rgb(String colorStr)
protected void	initFile(String id) Initializes the given file (parsing header information, etc.).
private void	initializeJHDFService(String id)
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.
private void	parseCellObjects()
private void	parseROIs(int s)
private void	parseStructure()
void	reopenFile() Reopen any files that were closed, and which are expected to be open while the reader is open.

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, get16BitLookupTable, 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, getOptimalTileWidth, getPixelType, getPixelType, getPossibleDomains, getPulse, getRequiredDirectories, getResolution, getResolutionCount, getRGBChannelCount, getRotationTransform, getSeries, getSeriesCount, getSeriesMeta, getSeriesMetadata, getSeriesMetadataValue, getSeriesUsedFiles, 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, isSingleFile, isThisType, isThisType, isThumbnailSeries, isUsedFile, makeFilterMetadata, openBytes, openBytes, openBytes, openPlane, openThumbBytes, 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

HDF_MAGIC_STRING

public static final String HDF_MAGIC_STRING

See Also:

Constant Field Values

pixelSizeX

private double pixelSizeX

pixelSizeY

private double pixelSizeY

pixelSizeZ

private double pixelSizeZ

minX

private double minX

minY

private double minY

minZ

private double minZ

maxX

private double maxX

maxY

private double maxY

maxZ

private double maxZ

seriesCount

private int seriesCount

jhdf

private transient JHDFService jhdf

store

private MetadataStore store

lastChannel

private int lastChannel

CellH5PositionList

private List<CellH5Reader.CellH5Coordinate> CellH5PositionList

CellH5PathsToImageData

private List<String> CellH5PathsToImageData

cellObjectNames

private List<String> cellObjectNames

COLORS

private final int[][] COLORS

times

private ch.systemsx.cisd.hdf5.HDF5CompoundDataMap[] times

classes

private ch.systemsx.cisd.hdf5.HDF5CompoundDataMap[] classes

bbox

private ch.systemsx.cisd.hdf5.HDF5CompoundDataMap[] bbox

Constructor Detail

CellH5Reader

public CellH5Reader()

Constructs a new CellH5 HDF reader.

Method Detail

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

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.

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

get8BitLookupTable

public byte[][] get8BitLookupTable()

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

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)

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

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

reopenFile

public void reopenFile()
                throws IOException

Description copied from interface: IFormatReader

Reopen any files that were closed, and which are expected to be open while the reader is open. This assumes that IFormatHandler.setId(java.lang.String) has been called, but close(false) has not been called.

Specified by:

reopenFile in interface IFormatReader

Overrides:

reopenFile in class FormatReader

Throws:

IOException

initializeJHDFService

private void initializeJHDFService(String id)
                            throws IOException,
                                   MissingLibraryException

Throws:

IOException

MissingLibraryException

getImageData

private Object getImageData(int no,
                  int y,
                  int height)
                     throws FormatException

Throws:

FormatException

parseStructure

private void parseStructure()
                     throws FormatException

Throws:

FormatException

parseCellObjects

private void parseCellObjects()

getChannelIndexOfCellObjectName

private int getChannelIndexOfCellObjectName(String cellObjectName)

hex2Rgb

private static Color hex2Rgb(String colorStr)

parseROIs

private void parseROIs(int s)