TIFFImageReader (Bio-Formats API)

java.lang.Object
- javax.imageio.ImageReader
- - com.sun.media.imageioimpl.plugins.tiff.TIFFImageReader

public class TIFFImageReader
extends ImageReader

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) int[]`	`bitsPerSample`
`(package private) char[]`	`colorMap`
`(package private) int`	`compression`
`(package private) int`	`currIndex`
`private static boolean`	`DEBUG`
`private TIFFDecompressor`	`decompressor`
`private int[]`	`destinationBands`
`(package private) int`	`dstHeight`
`(package private) int`	`dstMinX`
`(package private) int`	`dstMinY`
`(package private) int`	`dstWidth`
`(package private) int`	`dstXOffset`
`(package private) int`	`dstYOffset`
`(package private) int[]`	`extraSamples`
`(package private) boolean`	`gotHeader`
`(package private) int`	`height`
`(package private) TIFFImageMetadata`	`imageMetadata`
`(package private) ImageReadParam`	`imageReadParam`
`(package private) List`	`imageStartPosition`
`(package private) HashMap`	`imageTypeMap`
`(package private) int`	`numBands`
`(package private) int`	`numImages`
`(package private) int`	`photometricInterpretation`
`(package private) int`	`pixelsRead`
`(package private) int`	`pixelsToRead`
`(package private) int`	`planarConfiguration`
`(package private) int`	`rowsDone`
`(package private) int[]`	`sampleFormat`
`(package private) int`	`samplesPerPixel`
`private int[]`	`sourceBands`
`(package private) int`	`sourceXOffset`
`(package private) int`	`sourceYOffset`
`(package private) int`	`srcXSubsampling`
`(package private) int`	`srcYSubsampling`
`(package private) ImageInputStream`	`stream`
`(package private) TIFFStreamMetadata`	`streamMetadata`
`(package private) BufferedImage`	`theImage`
`(package private) int`	`tileOrStripHeight`
`(package private) int`	`tileOrStripWidth`
`(package private) int`	`tilesAcross`
`(package private) int`	`tilesDown`
`(package private) int`	`width`

Fields inherited from class javax.imageio.ImageReader
availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

Constructor Summary

Constructors
Constructor and Description

TIFFImageReader(ImageReaderSpi originatingProvider)

Constructors
Constructor and Description
`TIFFImageReader(ImageReaderSpi originatingProvider)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canReadRaster()`
`private void`	`checkIndex(int imageIndex)`
`private void`	`decodeTile(int ti, int tj, int band)`
`(package private) void`	`forwardWarningMessage(String warning)` Package scope method to allow decompressors, for example, to emit warning messages.
`private int`	`getCompression()`
`ImageReadParam`	`getDefaultReadParam()`
`protected static BufferedImage`	`getDestination(ImageReadParam param, Iterator imageTypes, int width, int height)`
`private int`	`getHeight()`
`int`	`getHeight(int imageIndex)`
`IIOMetadata`	`getImageMetadata(int imageIndex)`
`Iterator`	`getImageTypes(int imageIndex)`
`private int`	`getNumBands()`
`int`	`getNumImages(boolean allowSearch)`
`int`	`getNumThumbnails(int imageIndex)`
`private int`	`getPlanarConfiguration()`
`IIOMetadata`	`getStreamMetadata()`
`IIOMetadata`	`getStreamMetadata(int imageIndex)`
`int`	`getTileHeight(int imageIndex)`
`private long`	`getTileOrStripByteCount(int tileIndex)`
`private int`	`getTileOrStripHeight()`
`private long`	`getTileOrStripOffset(int tileIndex)`
`private int`	`getTileOrStripWidth()`
`int`	`getTileWidth(int imageIndex)`
`private int`	`getWidth()`
`int`	`getWidth(int imageIndex)`
`boolean`	`hasThumbnails(int imageIndex)`
`private static int`	`iceil(int num, int den)`
`private static int`	`ifloor(int num, int den)`
`private void`	`initializeFromMetadata()` Initializes these instance variables from the image metadata:
`boolean`	`isImageTiled(int imageIndex)`
`boolean`	`isRandomAccessEasy(int imageIndex)`
`private int`	`locateImage(int imageIndex)`
`private void`	`prepareRead(int imageIndex, ImageReadParam param)`
`BufferedImage`	`read(int imageIndex, ImageReadParam param)`
`RenderedImage`	`readAsRenderedImage(int imageIndex, ImageReadParam param)`
`private void`	`readHeader()`
`private void`	`readMetadata()`
`Raster`	`readRaster(int imageIndex, ImageReadParam param)`
`boolean`	`readSupportsThumbnails()`
`BufferedImage`	`readTile(int imageIndex, int tileX, int tileY)`
`private void`	`reportProgress()`
`void`	`reset()`
`protected void`	`resetLocal()`
`private void`	`seekToImage(int imageIndex)`
`void`	`setInput(Object input, boolean seekForwardOnly, boolean ignoreMetadata)`

Methods inherited from class javax.imageio.ImageReader
abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, checkReadParamBandSettings, clearAbortRequest, computeRegions, dispose, getAspectRatio, getAvailableLocales, getDestination, getFormatName, getImageMetadata, getInput, getLocale, getMinIndex, getOriginatingProvider, getRawImageType, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, isIgnoringMetadata, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, readAll, readAll, readerSupportsThumbnails, readThumbnail, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, setInput, setInput, setLocale

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG
```
private static final boolean DEBUG
```
See Also:

Constant Field Values

stream
```
ImageInputStream stream
```

gotHeader
```
boolean gotHeader
```

imageReadParam
```
ImageReadParam imageReadParam
```

streamMetadata
```
TIFFStreamMetadata streamMetadata
```

currIndex
```
int currIndex
```

imageMetadata
```
TIFFImageMetadata imageMetadata
```

imageStartPosition
```
List imageStartPosition
```

numImages
```
int numImages
```

imageTypeMap
```
HashMap imageTypeMap
```

theImage
```
BufferedImage theImage
```

width
```
int width
```

height
```
int height
```

numBands
```
int numBands
```

tileOrStripWidth
```
int tileOrStripWidth
```

tileOrStripHeight
```
int tileOrStripHeight
```

planarConfiguration
```
int planarConfiguration
```

rowsDone
```
int rowsDone
```

compression
```
int compression
```

photometricInterpretation
```
int photometricInterpretation
```

samplesPerPixel
```
int samplesPerPixel
```

sampleFormat
```
int[] sampleFormat
```

bitsPerSample
```
int[] bitsPerSample
```

extraSamples
```
int[] extraSamples
```

colorMap
```
char[] colorMap
```

sourceXOffset
```
int sourceXOffset
```

sourceYOffset
```
int sourceYOffset
```

srcXSubsampling
```
int srcXSubsampling
```

srcYSubsampling
```
int srcYSubsampling
```

dstWidth
```
int dstWidth
```

dstHeight
```
int dstHeight
```

dstMinX
```
int dstMinX
```

dstMinY
```
int dstMinY
```

dstXOffset
```
int dstXOffset
```

dstYOffset
```
int dstYOffset
```

tilesAcross
```
int tilesAcross
```

tilesDown
```
int tilesDown
```

pixelsRead
```
int pixelsRead
```

pixelsToRead
```
int pixelsToRead
```

sourceBands
```
private int[] sourceBands
```

destinationBands
```
private int[] destinationBands
```

decompressor
```
private TIFFDecompressor decompressor
```

Constructor Detail

TIFFImageReader

public TIFFImageReader(ImageReaderSpi originatingProvider)

Method Detail

setInput

public void setInput(Object input,
                     boolean seekForwardOnly,
                     boolean ignoreMetadata)

Overrides:: setInput in class ImageReader

readHeader

private void readHeader()
                 throws IIOException

Throws:: IIOException

locateImage

private int locateImage(int imageIndex)
                 throws IIOException

Throws:: IIOException

getNumImages

public int getNumImages(boolean allowSearch)
                 throws IOException

Specified by:: getNumImages in class ImageReader
Throws:: IOException

getStreamMetadata

public IIOMetadata getStreamMetadata()
                              throws IIOException

Specified by:: getStreamMetadata in class ImageReader
Throws:: IIOException

checkIndex

private void checkIndex(int imageIndex)

seekToImage

private void seekToImage(int imageIndex)
                  throws IIOException

Throws:: IIOException

readMetadata

private void readMetadata()
                   throws IIOException

Throws:: IIOException

getWidth
```
private int getWidth()
```

getHeight
```
private int getHeight()
```

getNumBands
```
private int getNumBands()
```

getTileOrStripWidth
```
private int getTileOrStripWidth()
```

getTileOrStripHeight
```
private int getTileOrStripHeight()
```

getPlanarConfiguration
```
private int getPlanarConfiguration()
```

getTileOrStripOffset

private long getTileOrStripOffset(int tileIndex)
                           throws IIOException

Throws:: IIOException

getTileOrStripByteCount

private long getTileOrStripByteCount(int tileIndex)
                              throws IOException

Throws:: IOException

getCompression
```
private int getCompression()
```

getWidth

public int getWidth(int imageIndex)
             throws IOException

Specified by:: getWidth in class ImageReader
Throws:: IOException

getHeight

public int getHeight(int imageIndex)
              throws IOException

Specified by:: getHeight in class ImageReader
Throws:: IOException

initializeFromMetadata

private void initializeFromMetadata()

Initializes these instance variables from the image metadata:

 compression
 width
 height
 samplesPerPixel
 numBands
 colorMap
 photometricInterpretation
 sampleFormat
 bitsPerSample
 extraSamples
 tileOrStripWidth
 tileOrStripHeight

getImageTypes

public Iterator getImageTypes(int imageIndex)
                       throws IIOException

Specified by:: getImageTypes in class ImageReader
Throws:: IIOException

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)
                             throws IIOException

Specified by:: getImageMetadata in class ImageReader
Throws:: IIOException

getStreamMetadata

public IIOMetadata getStreamMetadata(int imageIndex)
                              throws IIOException

Throws:: IIOException

isRandomAccessEasy

public boolean isRandomAccessEasy(int imageIndex)
                           throws IOException

Overrides:: isRandomAccessEasy in class ImageReader
Throws:: IOException

readSupportsThumbnails

public boolean readSupportsThumbnails()

hasThumbnails
```
public boolean hasThumbnails(int imageIndex)
```
Overrides:

hasThumbnails in class ImageReader

getNumThumbnails

public int getNumThumbnails(int imageIndex)
                     throws IOException

Overrides:: getNumThumbnails in class ImageReader
Throws:: IOException

getDefaultReadParam
```
public ImageReadParam getDefaultReadParam()
```
Overrides:

getDefaultReadParam in class ImageReader

isImageTiled

public boolean isImageTiled(int imageIndex)
                     throws IOException

Overrides:: isImageTiled in class ImageReader
Throws:: IOException

getTileWidth

public int getTileWidth(int imageIndex)
                 throws IOException

Overrides:: getTileWidth in class ImageReader
Throws:: IOException

getTileHeight

public int getTileHeight(int imageIndex)
                  throws IOException

Overrides:: getTileHeight in class ImageReader
Throws:: IOException

readTile

public BufferedImage readTile(int imageIndex,
                              int tileX,
                              int tileY)
                       throws IOException

Overrides:: readTile in class ImageReader
Throws:: IOException

canReadRaster
```
public boolean canReadRaster()
```
Overrides:

canReadRaster in class ImageReader

readRaster

public Raster readRaster(int imageIndex,
                         ImageReadParam param)
                  throws IOException

Overrides:: readRaster in class ImageReader
Throws:: IOException

ifloor

private static int ifloor(int num,
                          int den)

iceil

private static int iceil(int num,
                         int den)

prepareRead

private void prepareRead(int imageIndex,
                         ImageReadParam param)
                  throws IOException

Throws:: IOException

readAsRenderedImage

public RenderedImage readAsRenderedImage(int imageIndex,
                                         ImageReadParam param)
                                  throws IOException

Overrides:: readAsRenderedImage in class ImageReader
Throws:: IOException

decodeTile

private void decodeTile(int ti,
                        int tj,
                        int band)
                 throws IOException

Throws:: IOException

reportProgress
```
private void reportProgress()
```

read

public BufferedImage read(int imageIndex,
                          ImageReadParam param)
                   throws IOException

Specified by:: read in class ImageReader
Throws:: IOException

reset
```
public void reset()
```
Overrides:

reset in class ImageReader

resetLocal
```
protected void resetLocal()
```

forwardWarningMessage
```
void forwardWarningMessage(String warning)
```
Package scope method to allow decompressors, for example, to emit warning messages.

getDestination

protected static BufferedImage getDestination(ImageReadParam param,
                                              Iterator imageTypes,
                                              int width,
                                              int height)
                                       throws IIOException

Throws:: IIOException

Class TIFFImageReader

Field Summary

Fields inherited from class javax.imageio.ImageReader

Constructor Summary

Method Summary

Methods inherited from class javax.imageio.ImageReader

Methods inherited from class java.lang.Object

Field Detail

DEBUG

stream

gotHeader

imageReadParam

streamMetadata

currIndex

imageMetadata

imageStartPosition

numImages

imageTypeMap

theImage

width

height

numBands

tileOrStripWidth

tileOrStripHeight

planarConfiguration

rowsDone

compression

photometricInterpretation

samplesPerPixel

sampleFormat

bitsPerSample

extraSamples

colorMap

sourceXOffset

sourceYOffset

srcXSubsampling

srcYSubsampling

dstWidth

dstHeight

dstMinX

dstMinY

dstXOffset

dstYOffset

tilesAcross

tilesDown

pixelsRead

pixelsToRead

sourceBands

destinationBands

decompressor

Constructor Detail

TIFFImageReader

Method Detail

setInput

readHeader

locateImage

getNumImages

getStreamMetadata

checkIndex

seekToImage

readMetadata

getWidth

getHeight

getNumBands

getTileOrStripWidth

getTileOrStripHeight

getPlanarConfiguration

getTileOrStripOffset

getTileOrStripByteCount

getCompression

getWidth

getHeight

initializeFromMetadata

getImageTypes

getImageMetadata

getStreamMetadata

isRandomAccessEasy

readSupportsThumbnails

hasThumbnails

getNumThumbnails