Package loci.formats.in
Class OMETiffReader
java.lang.Object
loci.formats.FormatHandler
loci.formats.FormatReader
loci.formats.SubResolutionFormatReader
loci.formats.in.OMETiffReader
- All Implemented Interfaces:
Closeable,AutoCloseable,loci.formats.ICompressedTileReader,loci.formats.IFormatHandler,loci.formats.IFormatReader,loci.formats.IMetadataConfigurable,loci.formats.IPyramidHandler
OMETiffReader is the file format reader for
OME-TIFF
files.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final booleanstatic final Stringprotected loci.formats.in.OMETiffReader.OMETiffPlane[][]Mapping from series and plane numbers to files and IFD entries.static final String[]protected String[]List of used files.Fields inherited from class loci.formats.SubResolutionFormatReader
coreFields inherited from class loci.formats.FormatReader
coreIndex, datasetDescription, domains, fillColor, filterMetadata, flattenedResolutions, group, hasCompanionFiles, in, indexedAsRGB, metadata, metadataStore, normalizeData, resolution, saveOriginalMetadata, series, suffixNecessary, suffixSufficient, THUMBNAIL_DIMENSIONFields inherited from class loci.formats.FormatHandler
COMPRESSION_SUFFIXES, currentId, format, LOGGER, metadataOptions, suffixesFields inherited from interface loci.formats.IFormatReader
CAN_GROUP, CANNOT_GROUP, MUST_GROUP -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclose(boolean fileOnly) booleanintshort[][]byte[][]String[]Deprecated.Deprecated.Use the generalFormatReader.getMetadataStore()method.intintintgetRequiredDirectories(String[] files) String[]getSeriesUsedFiles(boolean noPixels) protected voidbooleanisSingleFile(String id) booleanisThisType(String name, boolean open) booleanisThisType(RandomAccessInputStream stream) byte[]openBytes(int no, byte[] buf, int x, int y, int w, int h) voidvoidsetSeries(int series) Methods inherited from class loci.formats.SubResolutionFormatReader
coreIndexToSeries, flattenHashtables, getCoreIndex, getCoreMetadataList, getCurrentCore, getResolution, getResolutionCount, getSeries, getSeriesCount, seriesToCoreIndex, setCoreIndex, setResolutionMethods 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, getAcquisitionMode, getAdvancedSeriesUsedFiles, getAdvancedUsedFiles, getArcType, getBinning, getBitsPerPixel, getCompression, getContrastMethod, getCorrection, getCurrentFile, getDatasetStructureDescription, getDetectorType, getDimensionOrder, getDimensionOrder, 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, getPixelType, getPixelType, getPossibleDomains, getPulse, getRGBChannelCount, getRotationTransform, getSeriesMeta, getSeriesMetadata, getSeriesMetadataValue, getSeriesUsedFiles, getSizeC, getSizeT, getSizeX, getSizeY, getSizeZ, getThumbSizeX, getThumbSizeY, getTileColumns, getTileRows, 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, readPlane, setFillColor, setFlattenedResolutions, setGroupFiles, setId, setMetadataFiltered, setMetadataStore, setNormalized, setOriginalMetadataPopulated, updateMetadataListsMethods inherited from class loci.formats.FormatHandler
checkSuffix, checkSuffix, getFormat, getMetadataOptions, getNativeDataType, getSuffixes, getSupportedMetadataLevels, setMetadataOptionsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface loci.formats.ICompressedTileReader
getTileCodec, getTileCodecOptions, openCompressedBytes, openCompressedBytesMethods inherited from interface loci.formats.IFormatHandler
getFormat, getNativeDataType, getSuffixesMethods inherited from interface loci.formats.IMetadataConfigurable
getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions
-
Field Details
-
OME_TIFF_SUFFIXES
-
FAIL_ON_MISSING_KEY
- See Also:
-
FAIL_ON_MISSING_DEFAULT
public static final boolean FAIL_ON_MISSING_DEFAULT- See Also:
-
info
protected loci.formats.in.OMETiffReader.OMETiffPlane[][] infoMapping from series and plane numbers to files and IFD entries. -
used
List of used files.
-
-
Constructor Details
-
OMETiffReader
public OMETiffReader()Constructs a new OME-TIFF reader.
-
-
Method Details
-
getAvailableOptions
- Overrides:
getAvailableOptionsin classloci.formats.FormatReader
-
isSingleFile
- Specified by:
isSingleFilein interfaceloci.formats.IFormatReader- Overrides:
isSingleFilein classloci.formats.FormatReader- Throws:
loci.formats.FormatExceptionIOException
-
isThisType
- Specified by:
isThisTypein interfaceloci.formats.IFormatReader- Overrides:
isThisTypein classloci.formats.FormatReader
-
isThisType
- Specified by:
isThisTypein interfaceloci.formats.IFormatReader- Overrides:
isThisTypein classloci.formats.FormatReader- Throws:
IOException
-
getDomains
- Specified by:
getDomainsin interfaceloci.formats.IFormatReader- Overrides:
getDomainsin classloci.formats.FormatReader
-
setSeries
public void setSeries(int series) - Specified by:
setSeriesin interfaceloci.formats.IFormatReader- Overrides:
setSeriesin classloci.formats.SubResolutionFormatReader
-
get8BitLookupTable
- Specified by:
get8BitLookupTablein interfaceloci.formats.IFormatReader- Overrides:
get8BitLookupTablein classloci.formats.FormatReader- Throws:
loci.formats.FormatExceptionIOException
-
get16BitLookupTable
- Specified by:
get16BitLookupTablein interfaceloci.formats.IFormatReader- Overrides:
get16BitLookupTablein classloci.formats.FormatReader- Throws:
loci.formats.FormatExceptionIOException
-
reopenFile
- Specified by:
reopenFilein interfaceloci.formats.IFormatReader- Overrides:
reopenFilein classloci.formats.FormatReader- Throws:
IOException
-
openBytes
public byte[] openBytes(int no, byte[] buf, int x, int y, int w, int h) throws loci.formats.FormatException, IOException - Specified by:
openBytesin interfaceloci.formats.IFormatReader- Specified by:
openBytesin classloci.formats.FormatReader- Throws:
loci.formats.FormatExceptionIOException
-
getSeriesUsedFiles
- Specified by:
getSeriesUsedFilesin interfaceloci.formats.IFormatReader- Overrides:
getSeriesUsedFilesin classloci.formats.FormatReader
-
fileGroupOption
- Specified by:
fileGroupOptionin interfaceloci.formats.IFormatReader- Overrides:
fileGroupOptionin classloci.formats.FormatReader
-
close
- Specified by:
closein interfaceloci.formats.IFormatReader- Overrides:
closein classloci.formats.SubResolutionFormatReader- Throws:
IOException
-
getOptimalTileWidth
public int getOptimalTileWidth()- Specified by:
getOptimalTileWidthin interfaceloci.formats.IFormatReader- Overrides:
getOptimalTileWidthin classloci.formats.FormatReader
-
getOptimalTileHeight
public int getOptimalTileHeight()- Specified by:
getOptimalTileHeightin interfaceloci.formats.IFormatReader- Overrides:
getOptimalTileHeightin classloci.formats.FormatReader
-
getRequiredDirectories
- Specified by:
getRequiredDirectoriesin interfaceloci.formats.IFormatReader- Overrides:
getRequiredDirectoriesin classloci.formats.FormatReader- Throws:
loci.formats.FormatExceptionIOException
-
initFile
- Overrides:
initFilein classloci.formats.SubResolutionFormatReader- Throws:
loci.formats.FormatExceptionIOException
-
getMetadataStoreForDisplay
Deprecated.Use the generalFormatReader.getMetadataStore()method.Get a MetadataStore suitable for display. Note: Historically, this method removed certain elements for display purposes and was not be suitable for use with FormatWriter due to not containing required BinData BigEndian attributes. This is no longer the case; the generalFormatReader.getMetadataStore()method will always create valid metadata which is suitable for both display and use with FormatWriter, and so should be used instead.- Returns:
- the metadata store.
-
getMetadataStoreForConversion
Deprecated.Use the generalFormatReader.getMetadataStore()method.Get a MetadataStore suitable for writing. Note: Historically, this method created metadata suitable for use with FormatWriter, but would possibly not generate valid OME-XML if both BinData and TiffData elements were present. This is no longer the case; the generalFormatReader.getMetadataStore()method will always create valid metadata which is suitable for use with FormatWriter, and so should be used instead.- Returns:
- the metadata store.
-
failOnMissingTIFF
public boolean failOnMissingTIFF()
-
FormatReader.getMetadataStore()method.