Package loci.formats.in

Class SlideBook7Reader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.in.SlideBook7Reader

All Implemented Interfaces:

Closeable, AutoCloseable, ICompressedTileReader, IFormatHandler, IFormatReader, IMetadataConfigurable, IPyramidHandler

public class SlideBook7Reader
extends FormatReader

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	SlideBook7Reader.CAlignManipRecord70
(package private) class	SlideBook7Reader.CAnnotation70
(package private) class	SlideBook7Reader.CChannelDef70
(package private) class	SlideBook7Reader.CChannelRecord70
(package private) class	SlideBook7Reader.CCompressionBase
(package private) class	SlideBook7Reader.CCube
(package private) class	SlideBook7Reader.CCubeAnnotation70
(package private) class	SlideBook7Reader.CDataTableHeaderRecord70
(package private) class	SlideBook7Reader.CExposureRecord70
(package private) class	SlideBook7Reader.CFluorDef70
(package private) class	SlideBook7Reader.CFRAPRegionAnnotation70
(package private) class	SlideBook7Reader.CFRETManipRecord70
(package private) class	SlideBook7Reader.CHistogramRecord70
(package private) class	SlideBook7Reader.CImageData
(package private) class	SlideBook7Reader.CImageGroup
(package private) class	SlideBook7Reader.CImageRecord70
(package private) class	SlideBook7Reader.ClassDecoder
(package private) class	SlideBook7Reader.CLensDef70
(package private) class	SlideBook7Reader.CMainViewRecord70
(package private) class	SlideBook7Reader.CMaskRecord70
(package private) class	SlideBook7Reader.CNpyHeader
(package private) class	SlideBook7Reader.COptovarDef70
(package private) class	SlideBook7Reader.CRatioManipRecord70
(package private) class	SlideBook7Reader.CRemapChannelLUT70
(package private) class	SlideBook7Reader.CRemapManipRecord70
(package private) class	SlideBook7Reader.CRemapPoint
(package private) class	SlideBook7Reader.CSBFile70
(package private) class	SlideBook7Reader.CSBPoint<T>
(package private) class	SlideBook7Reader.CSlideRecord70
(package private) class	SlideBook7Reader.CUnknownAnnotation70
(package private) class	SlideBook7Reader.DataLoader
(package private) static enum	SlideBook7Reader.EGraphicType
(package private) static class	SlideBook7Reader.IntIntPair
(package private) static class	SlideBook7Reader.StrIntPair

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOGGER
(package private) SlideBook7Reader.DataLoader	mDataLoader

Fields inherited from class loci.formats.FormatReader

core, coreIndex, datasetDescription, domains, fillColor, 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, metadataOptions, suffixes

Fields inherited from interface loci.formats.IFormatReader

CAN_GROUP, CANNOT_GROUP, MUST_GROUP

Constructor Summary

Constructors

Constructor	Description
SlideBook7Reader()

Method Summary

Modifier and Type	Method	Description
protected int	addAnnotation(MetadataStore store, SlideBook7Reader.CAnnotation70 inAnn, int inCapture, int inRegionIndex, int inRoiManagerRoiIndex)
void	close(boolean fileOnly)	Closes the currently open file.
private void	findAllFiles(loci.common.Location root, ArrayList<String> files, boolean noPixels)
String[]	getUsedFiles(boolean noPixels)	Returns an array of filenames needed to open this dataset.
protected void	initFile(String id)	Initializes the given file (parsing header information, etc.).
boolean	isSingleFile(String id)	Returns true if the named file is expected to be the only file in the dataset.
boolean	isThisType(String file, boolean open)	Checks if a file matches the type of this format reader.
boolean	isThisType(loci.common.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.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, get8BitLookupTable, getAcquisitionMode, getAdvancedSeriesUsedFiles, getAdvancedUsedFiles, getArcType, getAvailableOptions, getBinning, getBitsPerPixel, getCompression, getContrastMethod, getCoreIndex, getCoreMetadataList, getCorrection, getCurrentCore, getCurrentFile, getDatasetStructureDescription, getDetectorType, getDimensionOrder, getDimensionOrder, getDomains, getEffectiveSizeC, getExperimentType, getFilamentType, getFillColor, getFillRule, getFilterType, getFontFamily, getFontStyle, getGlobalMeta, getGlobalMetadata, getIlluminationType, getImageCount, getImmersion, getIndex, getIndex, getLaserMedium, getLaserType, getMarker, getMedium, getMetadataStore, getMetadataStoreRoot, getMetadataValue, getMicrobeamManipulationType, getMicroscopeType, getModuloC, getModuloT, getModuloZ, getNamingConvention, getOptimalTileHeight, getOptimalTileWidth, getPixelType, getPixelType, getPossibleDomains, getPulse, getRequiredDirectories, getResolution, getResolutionCount, getRGBChannelCount, getRotationTransform, getSeries, getSeriesCount, getSeriesMeta, getSeriesMetadata, getSeriesMetadataValue, getSeriesUsedFiles, getSeriesUsedFiles, getSizeC, getSizeT, getSizeX, getSizeY, getSizeZ, getThumbSizeX, getThumbSizeY, getTileColumns, getTileRows, getUnderlyingReaders, 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, readPlane, reopenFile, seriesToCoreIndex, setCoreIndex, setFillColor, setFlattenedResolutions, setGroupFiles, setId, setMetadataFiltered, setMetadataStore, setNormalized, setOriginalMetadataPopulated, setResolution, setSeries, updateMetadataLists

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

getTileCodec, getTileCodecOptions, openCompressedBytes, openCompressedBytes

Methods inherited from interface loci.formats.IFormatHandler

getFormat, getNativeDataType, getSuffixes

Methods inherited from interface loci.formats.IMetadataConfigurable

getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions

Field Details

LOGGER

public static org.slf4j.Logger LOGGER

mDataLoader

SlideBook7Reader.DataLoader mDataLoader

Constructor Details

SlideBook7Reader

public SlideBook7Reader()

Method Details

isThisType

public boolean isThisType(loci.common.RandomAccessInputStream stream)
                   throws IOException

Description copied from interface: IFormatReader

Checks if the given stream is a valid stream for this file format. The number of bytes read is format-dependent.

Specified by:

isThisType in interface IFormatReader

Overrides:

isThisType in class FormatReader

Parameters:

stream - A RandomAccessInputStream representing the file to check. The first byte in the stream is assumed to be the first byte in the file.

Returns:

true if the file represented by the stream can be read by this reader; false otherwise.

Throws:

IOException

isThisType

public boolean isThisType(String file,
 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

Parameters:

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 the named file is expected to be the only file in the dataset. For single-file formats, always returns true.

Specified by:

isSingleFile in interface IFormatReader

Overrides:

isSingleFile in class FormatReader

Throws:

FormatException

IOException

findAllFiles

private void findAllFiles(loci.common.Location root,
 ArrayList<String> files,
 boolean noPixels)

getUsedFiles

public String[] getUsedFiles(boolean noPixels)

Description copied from interface: IFormatReader

Returns an array of filenames needed to open this dataset. 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:

getUsedFiles in interface IFormatReader

Overrides:

getUsedFiles 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 plane index within the current series.

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

addAnnotation

protected int addAnnotation(MetadataStore store,
 SlideBook7Reader.CAnnotation70 inAnn,
 int inCapture,
 int inRegionIndex,
 int inRoiManagerRoiIndex)

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