Package loci.formats.in

Class JPEGReader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.DelegateReader

loci.formats.in.JPEGReader

All Implemented Interfaces:

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

public class JPEGReader
extends DelegateReader

JPEGReader is the file format reader for JPEG images.

Author:

Curtis Rueden ctrueden at wisc.edu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JPEGReader.DefaultJPEGReader

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	initialUseLegacy	setId may alter the "useLegacy" variable depending upon the type of JPEG encountered.
private static final int	MAX_SIZE

Fields inherited from class loci.formats.DelegateReader

legacyReader, legacyReaderInitialized, nativeReader, nativeReaderInitialized, useLegacy

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, LOGGER, metadataOptions, suffixes

Fields inherited from interface loci.formats.IFormatReader

CAN_GROUP, CANNOT_GROUP, MUST_GROUP

Constructor Summary

Constructors

Constructor	Description
JPEGReader()	Constructs a new JPEGReader.

Method Summary

Modifier and Type	Method	Description
void	close(boolean fileOnly)	Closes the currently open file.
String[]	getSeriesUsedFiles(boolean noPixels)	Returns an array of filenames needed to open the current series.
void	setId(String id)	Initialize a reader from the input file name.

Methods inherited from class loci.formats.DelegateReader

get16BitLookupTable, get8BitLookupTable, getMetadataOptions, getOptimalTileHeight, getOptimalTileWidth, getSupportedMetadataLevels, isLegacy, isThisType, isThisType, openBytes, reopenFile, setCoreIndex, setFlattenedResolutions, setGroupFiles, setLegacy, setMetadataFiltered, setMetadataOptions, setMetadataStore, setNormalized, setOriginalMetadataPopulated, setResolution, setSeries

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, 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, getPixelType, getPixelType, getPossibleDomains, getPulse, getRequiredDirectories, getResolution, getResolutionCount, getRGBChannelCount, getRotationTransform, getSeries, getSeriesCount, getSeriesMeta, getSeriesMetadata, getSeriesMetadataValue, getSeriesUsedFiles, getSizeC, getSizeT, getSizeX, getSizeY, getSizeZ, getThumbSizeX, getThumbSizeY, getTileColumns, getTileRows, getUnderlyingReaders, getUsedFiles, getUsedFiles, getZCTCoords, getZCTModuloCoords, hasCompanionFiles, hasFlattenedResolutions, initFile, 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, readPlane, seriesToCoreIndex, setFillColor, updateMetadataLists

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

getTileCodec, getTileCodecOptions, openCompressedBytes, openCompressedBytes

Methods inherited from interface loci.formats.IFormatHandler

getFormat, getNativeDataType, getSuffixes

Field Details

MAX_SIZE

private static final int MAX_SIZE

See Also:

• Constant Field Values

initialUseLegacy

private boolean initialUseLegacy

setId may alter the "useLegacy" variable depending upon the type of JPEG encountered. Storing the state of the "useLegacy" variable prior to any internal changes allows the reader to reset "useLegacy" to its original state upon close.

Constructor Details

JPEGReader

public JPEGReader()

Constructs a new JPEGReader.

Method Details

setId

public void setId(String id)
           throws FormatException,
IOException

Description copied from class: FormatReader

Initialize a reader from the input file name. Call FormatReader.initFile(String id) to initialize the input file, read all of the metadata and set the reader up for reading planes. The performance of this method depends on the format and can be up to several minutes for large file sets.

Specified by:

setId in interface IFormatHandler

Overrides:

setId in class DelegateReader

Parameters:

id - a String specifying the path to the file

Throws:

FormatException

IOException

getSeriesUsedFiles

public 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 DelegateReader

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 DelegateReader

Throws:

IOException