loci.formats.in

Class OMEXMLReader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.in.OMEXMLReader

All Implemented Interfaces:

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

public class OMEXMLReader
extends FormatReader

OMEXMLReader is the file format reader for OME-XML files.

Source code:

Trac, Gitweb

Author:

Melissa Linkert melissa at glencoesoftware.com

Field Summary

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
OMEXMLReader() Constructs a new OME-XML reader.

Method Summary

Methods

Modifier and Type	Method and Description
void	close(boolean fileOnly) Closes the currently open file.
java.lang.String[]	getDomains() Returns the list of domains represented by the current file.
protected void	initFile(java.lang.String id) Initializes the given file (parsing header information, etc.).
boolean	isThisType(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.
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, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMetaList, close, coreIndexToSeries, fileGroupOption, flattenHashtables, get16BitLookupTable, get8BitLookupTable, getAcquisitionMode, getAdvancedSeriesUsedFiles, getAdvancedUsedFiles, getArcType, getBinning, getBitsPerPixel, getChannelDimLengths, getChannelDimTypes, getCompression, getContrastMethod, getCoreIndex, getCoreMetadata, getCoreMetadataList, getCorrection, getCurrentFile, getDatasetStructureDescription, getDetectorType, getDimensionOrder, getDimensionOrder, getEffectiveSizeC, getExperimentType, getFilamentType, getFillRule, getFilterType, getFontFamily, getFontStyle, getGlobalMeta, getGlobalMetadata, getIlluminationType, getImageCount, getImmersion, getIndex, getLaserMedium, getLaserType, getLineCap, getMarker, getMedium, getMetadataOptions, 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, getSupportedMetadataLevels, getThumbSizeX, getThumbSizeY, getUnderlyingReaders, getUsedFiles, getUsedFiles, getZCTCoords, 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

Constructor Detail

OMEXMLReader

public OMEXMLReader()

Constructs a new OME-XML reader.

Method Detail

isThisType

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

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.

getDomains

public java.lang.String[] getDomains()

Description copied from interface: IFormatReader

Returns the list of domains represented by the current file.

Specified by:

getDomains in interface IFormatReader

Overrides:

getDomains in class FormatReader

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)

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

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