loci.plugins.util

Class ImageProcessorReader

java.lang.Object

loci.formats.ReaderWrapper

loci.plugins.util.ImageProcessorReader

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatReader, IMetadataConfigurable

public class ImageProcessorReader
extends ReaderWrapper

A low-level reader for ImageProcessor objects. For a higher-level reader that returns ImagePlus objects, see ImagePlusReader instead.

Source code:

Trac, Gitweb

Field Summary

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
ImageProcessorReader() Constructs an ImageProcessorReader around a new image reader.
ImageProcessorReader(IFormatReader r) Constructs an ImageProcessorReader with the given reader.

Method Summary

Methods

Modifier and Type	Method and Description
Class<?>	getNativeDataType() Returns the native data type of image planes for this reader, as returned by IFormatReader.openPlane(int, int, int, int, int) or IFormatWriter.savePlane(int, java.lang.Object).
static ImageProcessorReader	makeImageProcessorReader(IFormatReader r) Converts the given reader into a ImageProcessorReader, wrapping if needed.
Object	openPlane(int no, int x, int y, int w, int h) Obtains the specified image plane (or sub-image thereof) in the reader's native data structure.
ImageProcessor[]	openProcessors(int no) Creates an ImageJ image processor object for the image plane at the given position.
ImageProcessor[]	openProcessors(int no, int x, int y, int w, int h) Returns an array of ImageProcessors that represent the given slice.
ImageProcessor[]	openThumbProcessors(int no)

Methods inherited from class loci.formats.ReaderWrapper

close, close, coreIndexToSeries, duplicate, fileGroupOption, get16BitLookupTable, get8BitLookupTable, getAdvancedSeriesUsedFiles, getAdvancedUsedFiles, getBitsPerPixel, getChannelDimLengths, getChannelDimTypes, getCoreIndex, getCoreMetadata, getCoreMetadataList, getCurrentFile, getDatasetStructureDescription, getDimensionOrder, getDomains, getEffectiveSizeC, getFormat, getGlobalMetadata, getImageCount, getIndex, getMetadata, getMetadataOptions, 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, getSupportedMetadataLevels, getThumbSizeX, getThumbSizeY, getUnderlyingReaders, getUsedFiles, getUsedFiles, getZCTCoords, hasCompanionFiles, hasFlattenedResolutions, isFalseColor, isGroupFiles, isIndexed, isInterleaved, isInterleaved, isLittleEndian, isMetadataCollected, isMetadataComplete, isMetadataFiltered, isNormalized, isOrderCertain, isOriginalMetadataPopulated, isRGB, isSingleFile, isThisType, isThisType, isThisType, isThisType, isThumbnailSeries, openBytes, openBytes, openBytes, openBytes, openThumbBytes, seriesToCoreIndex, setCoreIndex, setFlattenedResolutions, setGroupFiles, setId, setMetadataCollected, setMetadataFiltered, setMetadataOptions, 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

Constructor Detail

ImageProcessorReader

public ImageProcessorReader()

Constructs an ImageProcessorReader around a new image reader.

ImageProcessorReader

public ImageProcessorReader(IFormatReader r)

Constructs an ImageProcessorReader with the given reader.

Method Detail

makeImageProcessorReader

public static ImageProcessorReader makeImageProcessorReader(IFormatReader r)

Converts the given reader into a ImageProcessorReader, wrapping if needed.

openProcessors

public ImageProcessor[] openProcessors(int no)
                                throws FormatException,
                                       IOException

Creates an ImageJ image processor object for the image plane at the given position.

Parameters:

no - Position of image plane.

Throws:

FormatException

IOException

openThumbProcessors

public ImageProcessor[] openThumbProcessors(int no)
                                     throws FormatException,
                                            IOException

Throws:

FormatException

IOException

openProcessors

public ImageProcessor[] openProcessors(int no,
                              int x,
                              int y,
                              int w,
                              int h)
                                throws FormatException,
                                       IOException

Returns an array of ImageProcessors that represent the given slice. There is one ImageProcessor per RGB channel; i.e., length of returned array == getRGBChannelCount().

Parameters:

no - Position of image plane.

Throws:

FormatException

IOException

getNativeDataType

public Class<?> getNativeDataType()

Description copied from interface: IFormatHandler

Returns the native data type of image planes for this reader, as returned by IFormatReader.openPlane(int, int, int, int, int) or IFormatWriter.savePlane(int, java.lang.Object). For most readers this type will be a byte array; however, some readers call external APIs that work with other types such as BufferedImage.

Specified by:

getNativeDataType in interface IFormatHandler

Overrides:

getNativeDataType in class ReaderWrapper

openPlane

public Object openPlane(int no,
               int x,
               int y,
               int w,
               int h)
                 throws FormatException,
                        IOException

Description copied from interface: IFormatReader

Obtains the specified image plane (or sub-image thereof) in the reader's native data structure. For most readers this is a byte array; however, some readers call external APIs that work with other types such as BufferedImage. The openPlane method exists to maintain generality and efficiency while avoiding pollution of the API with AWT-specific logic.

Specified by:

openPlane in interface IFormatReader

Overrides:

openPlane in class ReaderWrapper

Throws:

FormatException

IOException

See Also:

FormatReader, BufferedImageReader