ome.formats.importer

Class OMEROWrapper

java.lang.Object

loci.formats.ReaderWrapper

loci.formats.MinMaxCalculator

ome.formats.importer.OMEROWrapper

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatReader, IMetadataConfigurable

public class OMEROWrapper
extends MinMaxCalculator

Author:

Brian Loranger brain at lifesci.dundee.ac.uk, Chris Allan callan at blackcat.ca

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	minMaxSet

Fields inherited from class loci.formats.MinMaxCalculator

chanMax, chanMin, minMaxDone, minMaxStore, planeMax, planeMin

Fields inherited from class loci.formats.ReaderWrapper

reader

Fields inherited from interface loci.formats.IFormatReader

CAN_GROUP, CANNOT_GROUP, MUST_GROUP

Constructor Summary

Constructors

Constructor and Description
OMEROWrapper(ImportConfig config) Wrapper for bio-formats
OMEROWrapper(ImportConfig config, long elapsedTime, File cacheDirectory)

Method Summary

Modifier and Type	Method and Description
void	close()
ImportConfig	getConfig()
ImageReader	getImageReader() Return the base image reader
MetadataOptions	getMetadataOptions()
Set<MetadataLevel>	getSupportedMetadataLevels()
boolean	isLeicaReader()
boolean	isMinMaxSet()
boolean	isSPWReader()
PixelData	openPlane2D(String id, int planeNumber, byte[] buf) Obtains an object which represents a given sub-image of a plane within the file.
PixelData	openPlane2D(String id, int planeNumber, byte[] buf, int x, int y, int w, int h) Obtains an object which represents a given sub-image of a plane within the file.
void	setMetadataOptions(MetadataOptions options)
protected void	updateMinMax(int no, byte[] buf, int len)

Methods inherited from class loci.formats.MinMaxCalculator

close, getChannelGlobalMaximum, getChannelGlobalMinimum, getChannelKnownMaximum, getChannelKnownMinimum, getMinMaxStore, getNativeDataType, getPlaneMaximum, getPlaneMinimum, initMinMax, isMinMaxPopulated, makeMinMaxCalculator, openBytes, openBytes, openBytes, openBytes, setMinMaxStore

Methods inherited from class loci.formats.ReaderWrapper

coreIndexToSeries, duplicate, fileGroupOption, get16BitLookupTable, get8BitLookupTable, getAdvancedSeriesUsedFiles, getAdvancedUsedFiles, getBitsPerPixel, getCoreIndex, getCoreMetadataList, getCurrentFile, getDatasetStructureDescription, getDimensionOrder, getDomains, getEffectiveSizeC, getFormat, getGlobalMetadata, getImageCount, getIndex, getIndex, getMetadataStore, getMetadataStoreRoot, getMetadataValue, getModuloC, getModuloT, getModuloZ, getOptimalTileHeight, getOptimalTileWidth, getPixelType, getPossibleDomains, getReader, getRequiredDirectories, getResolution, getResolutionCount, getRGBChannelCount, getSeries, getSeriesCount, getSeriesMetadata, getSeriesMetadataValue, getSeriesUsedFiles, getSeriesUsedFiles, getSizeC, getSizeT, getSizeX, getSizeY, getSizeZ, getSuffixes, getThumbSizeX, getThumbSizeY, getUnderlyingReaders, getUsedFiles, getUsedFiles, getZCTCoords, getZCTModuloCoords, hasCompanionFiles, hasFlattenedResolutions, isFalseColor, isGroupFiles, isIndexed, isInterleaved, isInterleaved, isLittleEndian, isMetadataComplete, isMetadataFiltered, isNormalized, isOrderCertain, isOriginalMetadataPopulated, isRGB, isSingleFile, isThisType, isThisType, isThisType, isThisType, isThumbnailSeries, openPlane, openThumbBytes, reopenFile, seriesToCoreIndex, setCoreIndex, setFlattenedResolutions, setGroupFiles, setId, setMetadataFiltered, setMetadataStore, setNormalized, setOriginalMetadataPopulated, setResolution, setSeries, unwrap, unwrap, unwrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

minMaxSet

public Boolean minMaxSet

Constructor Detail

OMEROWrapper

public OMEROWrapper(ImportConfig config)

Wrapper for bio-formats

Parameters:

config - - ImportConfit

OMEROWrapper

public OMEROWrapper(ImportConfig config,
                    long elapsedTime,
                    File cacheDirectory)

Method Detail

getConfig

public ImportConfig getConfig()

openPlane2D

public PixelData openPlane2D(String id,
                             int planeNumber,
                             byte[] buf)
                      throws FormatException,
                             IOException

Obtains an object which represents a given sub-image of a plane within the file.

Parameters:

id - The path to the file.

planeNumber - The plane or section within the file to obtain.

buf - Pre-allocated buffer which has a length that can fit the entire plane.

Returns:

an object which represents the plane.

Throws:

FormatException - If there is an error parsing the file.

IOException - If there is an error reading from the file or acquiring permissions to read the file.

openPlane2D

public PixelData openPlane2D(String id,
                             int planeNumber,
                             byte[] buf,
                             int x,
                             int y,
                             int w,
                             int h)
                      throws FormatException,
                             IOException

Obtains an object which represents a given sub-image of a plane within the file.

Parameters:

id - The path to the file.

planeNumber - The plane or section within the file to obtain.

buf - Pre-allocated buffer which has a length that can fit the byte count of the sub-image.

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:

an object which represents the sub-image of the plane.

Throws:

FormatException - If there is an error parsing the file.

IOException - If there is an error reading from the file or acquiring permissions to read the file.

isLeicaReader

public boolean isLeicaReader()

Returns:

true if reader being used is LeicaReader

isMinMaxSet

public boolean isMinMaxSet()
                    throws FormatException,
                           IOException

Returns:

true if min-max is set

Throws:

FormatException

IOException

updateMinMax

protected void updateMinMax(int no,
                            byte[] buf,
                            int len)
                     throws FormatException,
                            IOException

Overrides:

updateMinMax in class MinMaxCalculator

Throws:

FormatException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class ReaderWrapper

Throws:

IOException

getImageReader

public ImageReader getImageReader()

Return the base image reader

Returns:

See above.

isSPWReader

public boolean isSPWReader()

Returns:

true if using SPW reader

getMetadataOptions

public MetadataOptions getMetadataOptions()

Specified by:

getMetadataOptions in interface IMetadataConfigurable

Overrides:

getMetadataOptions in class ReaderWrapper

setMetadataOptions

public void setMetadataOptions(MetadataOptions options)

Specified by:

setMetadataOptions in interface IMetadataConfigurable

Overrides:

setMetadataOptions in class ReaderWrapper

getSupportedMetadataLevels

public Set<MetadataLevel> getSupportedMetadataLevels()

Specified by:

getSupportedMetadataLevels in interface IMetadataConfigurable

Overrides:

getSupportedMetadataLevels in class ReaderWrapper