APIdia Launch Partner
Top Fields Constructors Methods
com.sun.imageio.plugins.tiff

public Class TIFFRenderedImage

extends Object
implements RenderedImage
Class Inheritance
All Implemented Interfaces
java.awt.image.RenderedImage
Imports
java.awt.Rectangle, java.awt.image.BufferedImage, .ColorModel, .Raster, .RenderedImage, .SampleModel, .WritableRaster, java.io.IOException, java.util.Iterator, .List, .Vector, javax.imageio.ImageReadParam, .ImageTypeSpecifier, javax.imageio.plugins.tiff.TIFFImageReadParam, .TIFFTagSet

Field Summary

Modifier and TypeField and Description
private int
height

private int
imageIndex

private boolean
isSubsampling

private ImageTypeSpecifier
its

private TIFFImageReader
reader

private int
subsampleX

private int
subsampleY

private int
tileHeight

private ImageReadParam
tileParam

private int
tileWidth

private int
width

Constructor Summary

AccessConstructor and Description
public
TIFFRenderedImage(TIFFImageReader reader, int imageIndex, ImageReadParam readParam, int width, int height)

Method Summary

Modifier and TypeMethod and Description
private ImageReadParam

Returns:

copied parameters.
cloneImageReadParam(ImageReadParam
the parameters to be copied.
param, boolean
whether the TIFFTagSet settings should be copied if set.
copyTagSets)

Creates a copy of param.

public WritableRaster
copyData(WritableRaster raster)

Implements java.awt.image.RenderedImage.copyData.

Computes an arbitrary rectangular region of the RenderedImage and copies it into a caller-supplied WritableRaster.

public ColorModel
getColorModel()

Implements java.awt.image.RenderedImage.getColorModel.

Returns the ColorModel associated with this image.

public Raster
getData()

Implements java.awt.image.RenderedImage.getData.

Returns the image as one large tile (for tile based images this will require fetching the whole image and copying the image data over).

public Raster
getData(Rectangle rect)

Implements java.awt.image.RenderedImage.getData.

Computes and returns an arbitrary region of the RenderedImage.

public int
getHeight()

Implements java.awt.image.RenderedImage.getHeight.

Returns the height of the RenderedImage.

public int
getMinTileX()

Implements java.awt.image.RenderedImage.getMinTileX.

Returns the minimum tile index in the X direction.

public int
getMinTileY()

Implements java.awt.image.RenderedImage.getMinTileY.

Returns the minimum tile index in the Y direction.

public int
getMinX()

Implements java.awt.image.RenderedImage.getMinX.

Returns the minimum X coordinate (inclusive) of the RenderedImage.

public int
getMinY()

Implements java.awt.image.RenderedImage.getMinY.

Returns the minimum Y coordinate (inclusive) of the RenderedImage.

public int
getNumXTiles()

Implements java.awt.image.RenderedImage.getNumXTiles.

Returns the number of tiles in the X direction.

public int
getNumYTiles()

Implements java.awt.image.RenderedImage.getNumYTiles.

Returns the number of tiles in the Y direction.

public Object
getProperty(String name)

Implements java.awt.image.RenderedImage.getProperty.

Gets a property from the property set of this image.

public String[]
getPropertyNames()

Implements java.awt.image.RenderedImage.getPropertyNames.

Returns an array of names recognized by getProperty(String) or null, if no property names are recognized.

public SampleModel
getSampleModel()

Implements java.awt.image.RenderedImage.getSampleModel.

Returns the SampleModel associated with this image.

public Vector<RenderedImage>
getSources()

Implements java.awt.image.RenderedImage.getSources.

Returns a vector of RenderedImages that are the immediate sources of image data for this RenderedImage.

public Raster
getTile(int tileX, int tileY)

Implements java.awt.image.RenderedImage.getTile.

Returns tile (tileX, tileY).

public int
getTileGridXOffset()

Implements java.awt.image.RenderedImage.getTileGridXOffset.

Returns the X offset of the tile grid relative to the origin, i.e., the X coordinate of the upper-left pixel of tile (0, 0).

public int
getTileGridYOffset()

Implements java.awt.image.RenderedImage.getTileGridYOffset.

Returns the Y offset of the tile grid relative to the origin, i.e., the Y coordinate of the upper-left pixel of tile (0, 0).

public int
getTileHeight()

Implements java.awt.image.RenderedImage.getTileHeight.

Returns the tile height in pixels.

public int
getTileWidth()

Implements java.awt.image.RenderedImage.getTileWidth.

Returns the tile width in pixels.

public int
getWidth()

Implements java.awt.image.RenderedImage.getWidth.

Returns the width of the RenderedImage.

public synchronized WritableRaster
read(Rectangle rect)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

heightback to summary
private int height
imageIndexback to summary
private int imageIndex
isSubsamplingback to summary
private boolean isSubsampling
itsback to summary
private ImageTypeSpecifier its
readerback to summary
private TIFFImageReader reader
subsampleXback to summary
private int subsampleX
subsampleYback to summary
private int subsampleY
tileHeightback to summary
private int tileHeight
tileParamback to summary
private ImageReadParam tileParam
tileWidthback to summary
private int tileWidth
widthback to summary
private int width

Constructor Detail

TIFFRenderedImageback to summary
public TIFFRenderedImage(TIFFImageReader reader, int imageIndex, ImageReadParam readParam, int width, int height) throws IOException

Method Detail

cloneImageReadParamback to summary
private ImageReadParam cloneImageReadParam(ImageReadParam param, boolean copyTagSets)

Creates a copy of param. The source subsampling and and bands settings and the destination bands and offset settings are copied. If param is a TIFFImageReadParam then the TIFFDecompressor and TIFFColorConverter settings are also copied; otherwise they are explicitly set to null.

Parameters
param:ImageReadParam

the parameters to be copied.

copyTagSets:boolean

whether the TIFFTagSet settings should be copied if set.

Returns:ImageReadParam

copied parameters.

copyDataback to summary
public WritableRaster copyData(WritableRaster raster)

Implements java.awt.image.RenderedImage.copyData.

Doc from java.awt.image.RenderedImage.copyData.

Computes an arbitrary rectangular region of the RenderedImage and copies it into a caller-supplied WritableRaster. The region to be computed is determined from the bounds of the supplied WritableRaster. The supplied WritableRaster must have a SampleModel that is compatible with this image. If raster is null, an appropriate WritableRaster is created.

Annotations
@Override
getColorModelback to summary
public ColorModel getColorModel()

Implements java.awt.image.RenderedImage.getColorModel.

Doc from java.awt.image.RenderedImage.getColorModel.

Returns the ColorModel associated with this image. All Rasters returned from this image will have this as their ColorModel. This can return null.

Annotations
@Override
getDataback to summary
public Raster getData()

Implements java.awt.image.RenderedImage.getData.

Doc from java.awt.image.RenderedImage.getData.

Returns the image as one large tile (for tile based images this will require fetching the whole image and copying the image data over). The Raster returned is a copy of the image data and will not be updated if the image is changed.

Annotations
@Override
getDataback to summary
public Raster getData(Rectangle rect)

Implements java.awt.image.RenderedImage.getData.

Doc from java.awt.image.RenderedImage.getData.

Computes and returns an arbitrary region of the RenderedImage. The Raster returned is a copy of the image data and will not be updated if the image is changed.

Annotations
@Override
getHeightback to summary
public int getHeight()

Implements java.awt.image.RenderedImage.getHeight.

Doc from java.awt.image.RenderedImage.getHeight.

Returns the height of the RenderedImage.

Annotations
@Override
getMinTileXback to summary
public int getMinTileX()

Implements java.awt.image.RenderedImage.getMinTileX.

Doc from java.awt.image.RenderedImage.getMinTileX.

Returns the minimum tile index in the X direction.

Annotations
@Override
getMinTileYback to summary
public int getMinTileY()

Implements java.awt.image.RenderedImage.getMinTileY.

Doc from java.awt.image.RenderedImage.getMinTileY.

Returns the minimum tile index in the Y direction.

Annotations
@Override
getMinXback to summary
public int getMinX()

Implements java.awt.image.RenderedImage.getMinX.

Doc from java.awt.image.RenderedImage.getMinX.

Returns the minimum X coordinate (inclusive) of the RenderedImage.

Annotations
@Override
getMinYback to summary
public int getMinY()

Implements java.awt.image.RenderedImage.getMinY.

Doc from java.awt.image.RenderedImage.getMinY.

Returns the minimum Y coordinate (inclusive) of the RenderedImage.

Annotations
@Override
getNumXTilesback to summary
public int getNumXTiles()

Implements java.awt.image.RenderedImage.getNumXTiles.

Doc from java.awt.image.RenderedImage.getNumXTiles.

Returns the number of tiles in the X direction.

Annotations
@Override
getNumYTilesback to summary
public int getNumYTiles()

Implements java.awt.image.RenderedImage.getNumYTiles.

Doc from java.awt.image.RenderedImage.getNumYTiles.

Returns the number of tiles in the Y direction.

Annotations
@Override
getPropertyback to summary
public Object getProperty(String name)

Implements java.awt.image.RenderedImage.getProperty.

Doc from java.awt.image.RenderedImage.getProperty.

Gets a property from the property set of this image. The set of properties and whether it is immutable is determined by the implementing class. This method returns java.awt.Image.UndefinedProperty if the specified property is not defined for this RenderedImage.

Annotations
@Override
getPropertyNamesback to summary
public String[] getPropertyNames()

Implements java.awt.image.RenderedImage.getPropertyNames.

Doc from java.awt.image.RenderedImage.getPropertyNames.

Returns an array of names recognized by getProperty(String) or null, if no property names are recognized.

Annotations
@Override
getSampleModelback to summary
public SampleModel getSampleModel()

Implements java.awt.image.RenderedImage.getSampleModel.

Doc from java.awt.image.RenderedImage.getSampleModel.

Returns the SampleModel associated with this image. All Rasters returned from this image will have this as their SampleModel.

Annotations
@Override
getSourcesback to summary
public Vector<RenderedImage> getSources()

Implements java.awt.image.RenderedImage.getSources.

Doc from java.awt.image.RenderedImage.getSources.

Returns a vector of RenderedImages that are the immediate sources of image data for this RenderedImage. This method returns null if the RenderedImage object has no information about its immediate sources. It returns an empty Vector if the RenderedImage object has no immediate sources.

Annotations
@Override
getTileback to summary
public Raster getTile(int tileX, int tileY)

Implements java.awt.image.RenderedImage.getTile.

Doc from java.awt.image.RenderedImage.getTile.

Returns tile (tileX, tileY). Note that tileX and tileY are indices into the tile array, not pixel locations. The Raster that is returned is live and will be updated if the image is changed.

Annotations
@Override
getTileGridXOffsetback to summary
public int getTileGridXOffset()

Implements java.awt.image.RenderedImage.getTileGridXOffset.

Doc from java.awt.image.RenderedImage.getTileGridXOffset.

Returns the X offset of the tile grid relative to the origin, i.e., the X coordinate of the upper-left pixel of tile (0, 0). (Note that tile (0, 0) may not actually exist.)

Annotations
@Override
getTileGridYOffsetback to summary
public int getTileGridYOffset()

Implements java.awt.image.RenderedImage.getTileGridYOffset.

Doc from java.awt.image.RenderedImage.getTileGridYOffset.

Returns the Y offset of the tile grid relative to the origin, i.e., the Y coordinate of the upper-left pixel of tile (0, 0). (Note that tile (0, 0) may not actually exist.)

Annotations
@Override
getTileHeightback to summary
public int getTileHeight()

Implements java.awt.image.RenderedImage.getTileHeight.

Doc from java.awt.image.RenderedImage.getTileHeight.

Returns the tile height in pixels. All tiles must have the same height.

Annotations
@Override
getTileWidthback to summary
public int getTileWidth()

Implements java.awt.image.RenderedImage.getTileWidth.

Doc from java.awt.image.RenderedImage.getTileWidth.

Returns the tile width in pixels. All tiles must have the same width.

Annotations
@Override
getWidthback to summary
public int getWidth()

Implements java.awt.image.RenderedImage.getWidth.

Doc from java.awt.image.RenderedImage.getWidth.

Returns the width of the RenderedImage.

Annotations
@Override
readback to summary
public synchronized WritableRaster read(Rectangle rect)