Class TIFFImageReader

java.lang.Object

javax.imageio.ImageReader

com.twelvemonkeys.imageio.ImageReaderBase

com.twelvemonkeys.imageio.plugins.tiff.TIFFImageReader

public final class TIFFImageReader
extends ImageReaderBase

ImageReader implementation for Aldus/Adobe Tagged Image File Format (TIFF).

The reader is supposed to be fully "Baseline TIFF" compliant, and supports the following image types:

• Class B (Bi-level), all relevant compression types, 1 bit per sample
• Class G (Gray), all relevant compression types, 2, 4, 8, 16 or 32 bits per sample, unsigned integer
• Class P (Palette/indexed color), all relevant compression types, 1, 2, 4, 8 or 16 bits per sample, unsigned integer
• Class R (RGB), all relevant compression types, 8 or 16 bits per sample, unsigned integer

In addition, it supports many common TIFF extensions such as:

• Tiling
• Class F (Facsimile), CCITT T.4 and T.6 compression (types 3 and 4), 1 bit per sample
• LZW Compression (type 5)
• "Old-style" JPEG Compression (type 6), as a best effort, as the spec is not well-defined
• JPEG Compression (type 7)
• ZLib (aka Adobe-style Deflate) Compression (type 8)
• Deflate Compression (type 32946)
• Horizontal differencing Predictor (type 2) for LZW, ZLib, Deflate and PackBits compression
• Alpha channel (ExtraSamples types 1/Associated Alpha and 2/Unassociated Alpha)
• Class S, CMYK data (PhotometricInterpretation type 5/Separated)
• Class Y, YCbCr data (PhotometricInterpretation type 6/YCbCr for both JPEG and other compressions
• Planar data (PlanarConfiguration type 2/Planar)
• ICC profiles (ICCProfile)
• BitsPerSample values up to 16 for most PhotometricInterpretations
• Multiple images (pages) in one file

Version:

$Id: TIFFImageReader.java,v 1.0 08.05.12 15:14 haraldk Exp$

Author:

Harald Kuhr, last modified by $Author: haraldk$

See Also:

• Adobe TIFF developer resources
• TIFF 6.0 specification
• Wikipedia TIFF
• AWare Systems TIFF pages

Field Summary

Fields inherited from class ImageReaderBase

imageInput

Fields inherited from class ImageReader

availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

Method Summary

Modifier and Type	Method	Description
boolean	canReadRaster()
int	getHeight(int imageIndex)
IIOMetadata	getImageMetadata(int imageIndex)	Metadata
Iterator<ImageTypeSpecifier>	getImageTypes(int imageIndex)
int	getNumImages(boolean allowSearch)	Default implementation that always returns 1.
ImageTypeSpecifier	getRawImageType(int imageIndex)
IIOMetadata	getStreamMetadata()	Default implementation that always returns null.
int	getTileHeight(int imageIndex)
int	getTileWidth(int imageIndex)
int	getWidth(int imageIndex)
boolean	isImageTiled(int imageIndex)	Tiling support
static void	main(String[] args)
BufferedImage	read(int imageIndex, ImageReadParam param)
Raster	readRaster(int imageIndex, ImageReadParam param)
BufferedImage	readTile(int imageIndex, int tileX, int tileY)
Raster	readTileRaster(int imageIndex, int tileX, int tileY)
protected void	resetMembers()	Resets all member variables.
protected static void	showIt(BufferedImage image, String title)

Methods inherited from class ImageReaderBase

assertInput, checkBounds, dispose, fakeAOI, fakeSubsampling, getDestination, hasExplicitDestination, reset, setInput

Methods inherited from class ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, checkReadParamBandSettings, clearAbortRequest, computeRegions, getAspectRatio, getAvailableLocales, getDefaultReadParam, getFormatName, getImageMetadata, getInput, getLocale, getMinIndex, getNumThumbnails, getOriginatingProvider, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, hasThumbnails, isIgnoringMetadata, isRandomAccessEasy, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, readAll, readAll, readAsRenderedImage, readerSupportsThumbnails, readThumbnail, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, setInput, setInput, setLocale

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

resetMembers

protected void resetMembers()

Description copied from class: ImageReaderBase

Resets all member variables. This method is by default invoked from:

• ImageReaderBase.setInput(Object, boolean, boolean)
• ImageReaderBase.dispose()
• ImageReaderBase.reset()

Specified by:

resetMembers in class ImageReaderBase

getNumImages

public int getNumImages(boolean allowSearch)
                 throws IOException

Description copied from class: ImageReaderBase

Default implementation that always returns 1.

Overrides:

getNumImages in class ImageReaderBase

Parameters:

allowSearch - ignored, unless overridden

Returns:

1, unless overridden

Throws:

IOException - never, unless overridden

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

getRawImageType

public ImageTypeSpecifier getRawImageType(int imageIndex)
                                   throws IOException

Overrides:

getRawImageType in class ImageReader

Throws:

IOException

getImageTypes

public Iterator<ImageTypeSpecifier> getImageTypes(int imageIndex)
                                           throws IOException

Specified by:

getImageTypes in class ImageReader

Throws:

IOException

read

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

Specified by:

read 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

isImageTiled

public boolean isImageTiled(int imageIndex)
                     throws IOException

Tiling support

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

readTileRaster

public Raster readTileRaster(int imageIndex,
 int tileX,
 int tileY)
                      throws IOException

Overrides:

readTileRaster in class ImageReader

Throws:

IOException

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)
                             throws IOException

Metadata

Overrides:

getImageMetadata in class ImageReaderBase

Parameters:

imageIndex - ignored, unless overridden

Returns:

null, unless overridden

Throws:

IOException - never, unless overridden.

getStreamMetadata

public IIOMetadata getStreamMetadata()
                              throws IOException

Description copied from class: ImageReaderBase

Default implementation that always returns null.

Overrides:

getStreamMetadata in class ImageReaderBase

Returns:

null, unless overridden

Throws:

IOException - never, unless overridden.

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException

showIt

protected static void showIt(BufferedImage image,
 String title)