loci.formats.in

Class BDReader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.in.BDReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, IFormatHandler, IFormatReader, IMetadataConfigurable

public class BDReader
extends FormatReader

BDReader is the file format reader for BD Pathway datasets.

Author:

Shawn Garbett Shawn.Garbett a t Vanderbilt.edu

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	binning
private java.util.List<java.lang.String>	channelNames
private double[]	emWave
private static java.lang.String	EXPERIMENT_FILE
private double[]	exposure
private double[]	exWave
private int	fieldCols
private int	fieldRows
private double[]	gain
private static java.lang.String[]	META_EXT
private java.util.List<java.lang.String>	metadataFiles
private java.lang.String	objective
private double[]	offset
private java.lang.String	plateDescription
private java.lang.String	plateName
private MinimalTiffReader	reader
private java.lang.String	roiFile
private java.lang.String[]	rootList
private java.lang.String[][]	tiffs
private int	wellCols
private java.util.List<java.lang.String>	wellLabels
private java.util.List<java.lang.String[]>	wellList
private int	wellRows

Fields inherited from class loci.formats.FormatReader

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

Fields inherited from class loci.formats.FormatHandler

COMPRESSION_SUFFIXES, currentId, format, LOGGER, metadataOptions, suffixes

Fields inherited from interface loci.formats.IFormatReader

CAN_GROUP, CANNOT_GROUP, MUST_GROUP

Constructor Summary

Constructors

Constructor and Description
BDReader() Constructs a new ScanR reader.

Method Summary

Modifier and Type	Method and Description
void	close(boolean fileOnly) Closes the currently open file.
int	fileGroupOption(java.lang.String id) Returns an int indicating that we cannot, must, or might group the files in a given dataset.
private java.lang.String	getFilename(int series, 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.
java.lang.String[]	getSeriesUsedFiles(boolean noPixels) Returns an array of filenames needed to open the current series.
private java.lang.String[][]	getTiffs()
private long	getTimestamp(java.lang.String file)
protected void	initFile(java.lang.String id) Initializes the given file (parsing header information, etc.).
boolean	isSingleFile(java.lang.String id) Returns true if this is a single-file format.
boolean	isThisType(loci.common.RandomAccessInputStream stream) Checks if the given stream is a valid stream for this file format.
boolean	isThisType(java.lang.String name, boolean open) Checks if a file matches the type of this format reader.
private java.lang.String	locateExperimentFile(java.lang.String id)
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	parseChannelData(loci.common.Location dir)
private void	parseROIs(MetadataStore store)
private loci.common.IniList	readMetaData(java.lang.String id)

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, get16BitLookupTable, get8BitLookupTable, 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, getMarker, getMedium, 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, 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, setMetadataStore, setNormalized, setOriginalMetadataPopulated, setResolution, setSeries

Methods inherited from class loci.formats.FormatHandler

checkSuffix, checkSuffix, getFormat, getMetadataOptions, getNativeDataType, getSuffixes, getSupportedMetadataLevels, setMetadataOptions

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

Methods inherited from interface loci.formats.IMetadataConfigurable

getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions

Field Detail

EXPERIMENT_FILE

private static final java.lang.String EXPERIMENT_FILE

See Also:

Constant Field Values

META_EXT

private static final java.lang.String[] META_EXT

metadataFiles

private java.util.List<java.lang.String> metadataFiles

channelNames

private java.util.List<java.lang.String> channelNames

wellLabels

private java.util.List<java.lang.String> wellLabels

plateName

private java.lang.String plateName

plateDescription

private java.lang.String plateDescription

tiffs

private java.lang.String[][] tiffs

reader

private MinimalTiffReader reader

roiFile

private java.lang.String roiFile

emWave

private double[] emWave

exWave

private double[] exWave

gain

private double[] gain

offset

private double[] offset

exposure

private double[] exposure

binning

private java.lang.String binning

objective

private java.lang.String objective

wellRows

private int wellRows

wellCols

private int wellCols

fieldRows

private int fieldRows

fieldCols

private int fieldCols

rootList

private java.lang.String[] rootList

wellList

private java.util.List<java.lang.String[]> wellList

Constructor Detail

BDReader

public BDReader()

Constructs a new ScanR reader.

Method Detail

isThisType

public boolean isThisType(java.lang.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(loci.common.RandomAccessInputStream stream)
                   throws java.io.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:

java.io.IOException

getSeriesUsedFiles

public java.lang.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. The first element in the array is expected to be the path passed to IFormatHandler.setId(String), if appropriate based upon 'noPixels'. The remaining elements are expected to be in a consistent order; if a directory listing is necessary to build the list then it should be sorted first.

Specified by:

getSeriesUsedFiles in interface IFormatReader

Overrides:

getSeriesUsedFiles in class FormatReader

close

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

java.io.IOException

fileGroupOption

public int fileGroupOption(java.lang.String id)
                    throws FormatException,
                           java.io.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

java.io.IOException

isSingleFile

public boolean isSingleFile(java.lang.String id)
                     throws FormatException,
                            java.io.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

java.io.IOException

openBytes

public byte[] openBytes(int no,
                        byte[] buf,
                        int x,
                        int y,
                        int w,
                        int h)
                 throws FormatException,
                        java.io.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.

java.io.IOException - if there was a problem reading the file.

See Also:

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

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(java.lang.String id)
                 throws FormatException,
                        java.io.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.

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

locateExperimentFile

private java.lang.String locateExperimentFile(java.lang.String id)
                                       throws FormatException,
                                              java.io.IOException

Throws:

FormatException

java.io.IOException

readMetaData

private loci.common.IniList readMetaData(java.lang.String id)
                                  throws java.io.IOException

Throws:

java.io.IOException

parseChannelData

private void parseChannelData(loci.common.Location dir)
                       throws java.io.IOException

Throws:

java.io.IOException

getTiffs

private java.lang.String[][] getTiffs()

parseROIs

private void parseROIs(MetadataStore store)
                throws java.io.IOException

Throws:

java.io.IOException

getFilename

private java.lang.String getFilename(int series,
                                     int no)

getTimestamp

private long getTimestamp(java.lang.String file)
                   throws FormatException,
                          java.io.IOException

Throws:

FormatException

java.io.IOException