APIdia Launch Partner
Top Description Fields Constructors Methods
java.awt.image

public Class LookupOp

extends Object
implements BufferedImageOp, RasterOp
Class Inheritance
All Implemented Interfaces
java.awt.image.RasterOp, java.awt.image.BufferedImageOp
Imports
java.awt.color.ColorSpace, java.awt.geom.Rectangle2D, .Point2D, java.awt.Rectangle, .RenderingHints, sun.awt.image.ImagingLib

This class implements a lookup operation from the source to the destination. The LookupTable object may contain a single array or multiple arrays, subject to the restrictions below.

For Rasters, the lookup operates on bands. The number of lookup arrays may be one, in which case the same array is applied to all bands, or it must equal the number of Source Raster bands.

For BufferedImages, the lookup operates on color and alpha components. The number of lookup arrays may be one, in which case the same array is applied to all color (but not alpha) components. Otherwise, the number of lookup arrays may equal the number of Source color components, in which case no lookup of the alpha component (if present) is performed. If neither of these cases apply, the number of lookup arrays must equal the number of Source color components plus alpha components, in which case lookup is performed for all color and alpha components. This allows non-uniform rescaling of multi-band BufferedImages.

BufferedImage sources with premultiplied alpha data are treated in the same manner as non-premultiplied images for purposes of the lookup. That is, the lookup is done per band on the raw data of the BufferedImage source without regard to whether the data is premultiplied. If a color conversion is required to the destination ColorModel, the premultiplied state of both source and destination will be taken into account for this step.

Images with an IndexColorModel cannot be used.

If a RenderingHints object is specified in the constructor, the color rendering hint and the dithering hint may be used when color conversion is required.

This class allows the Source to be the same as the Destination.

See Also
LookupTable, java.awt.RenderingHints#KEY_COLOR_RENDERING, java.awt.RenderingHints#KEY_DITHERING

Field Summary

Modifier and TypeField and Description
pack-priv RenderingHints
private LookupTable
private int

Constructor Summary

AccessConstructor and Description
public
LookupOp(LookupTable
the specified LookupTable
lookup
,
RenderingHints
the specified RenderingHints, or null
hints
)

Constructs a LookupOp object given the lookup table and a RenderingHints object, which might be null.

Method Summary

Modifier and TypeMethod and Description
private void
byteFilter(ByteLookupTable lookup, Raster src, WritableRaster dst, int width, int height, int numBands)

public BufferedImage

Returns:

a filtered destination BufferedImage.
createCompatibleDestImage
(BufferedImage
Source image for the filter operation.
src
,
ColorModel
the destination's ColorModel, which can be null.
destCM
)

Implements java.awt.image.BufferedImageOp.createCompatibleDestImage.

Creates a zeroed destination image with the correct size and number of bands.

public WritableRaster

Returns:

the zeroed-destination Raster.
createCompatibleDestRaster
(Raster
the Raster to be transformed
src
)

Implements java.awt.image.RasterOp.createCompatibleDestRaster.

Creates a zeroed-destination Raster with the correct size and number of bands, given this source.

public final BufferedImage

Returns:

the filtered BufferedImage.
filter
(BufferedImage
the BufferedImage to be filtered
src
,
BufferedImage
the BufferedImage in which to store the results of the filter operation
dst
)

Implements java.awt.image.BufferedImageOp.filter.

Performs a lookup operation on a BufferedImage.

public final WritableRaster

Returns:

the filtered WritableRaster.
filter
(Raster
the source Raster to filter
src
,
WritableRaster
the destination WritableRaster for the filtered src
dst
)

Implements java.awt.image.RasterOp.filter.

Performs a lookup operation on a Raster.

public final Rectangle2D

Returns:

the bounds of the filtered definition image.
getBounds2D
(BufferedImage
the BufferedImage to be filtered
src
)

Implements java.awt.image.BufferedImageOp.getBounds2D.

Returns the bounding box of the filtered destination image.

public final Rectangle2D

Returns:

the bounds of the filtered definition Raster.
getBounds2D
(Raster
the Raster to be filtered
src
)

Implements java.awt.image.RasterOp.getBounds2D.

Returns the bounding box of the filtered destination Raster.

public final Point2D

Returns:

the Point2D in the destination that corresponds to the specified point in the source.
getPoint2D
(Point2D
a Point2D that represents a point in the source image
srcPt
,
Point2D
a Point2D that represents the location in the destination
dstPt
)

Implements java.awt.image.BufferedImageOp.getPoint2D, java.awt.image.RasterOp.getPoint2D.

Returns the location of the destination point given a point in the source.

public final RenderingHints

Returns:

the RenderingHints object associated with this op.
getRenderingHints
()

Implements java.awt.image.BufferedImageOp.getRenderingHints, java.awt.image.RasterOp.getRenderingHints.

Returns the rendering hints for this op.

public final LookupTable

Returns:

the LookupTable of this LookupOp.
getTable
()

Returns the LookupTable.

private void
shortFilter(ShortLookupTable lookup, Raster src, WritableRaster dst, int width, int height, int numBands)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

hintsback to summary
pack-priv RenderingHints hints
ltableback to summary
private LookupTable ltable
numComponentsback to summary
private int numComponents

Constructor Detail

LookupOpback to summary
public LookupOp(LookupTable lookup, RenderingHints hints)

Constructs a LookupOp object given the lookup table and a RenderingHints object, which might be null.

Parameters
lookup:LookupTable

the specified LookupTable

hints:RenderingHints

the specified RenderingHints, or null

Method Detail

byteFilterback to summary
private void byteFilter(ByteLookupTable lookup, Raster src, WritableRaster dst, int width, int height, int numBands)
createCompatibleDestImageback to summary
public BufferedImage createCompatibleDestImage(BufferedImage src, ColorModel destCM)

Implements java.awt.image.BufferedImageOp.createCompatibleDestImage.

Creates a zeroed destination image with the correct size and number of bands. If destCM is null, an appropriate ColorModel will be used.

Parameters
src:BufferedImage

Source image for the filter operation.

destCM:ColorModel

the destination's ColorModel, which can be null.

Returns:BufferedImage

a filtered destination BufferedImage.

createCompatibleDestRasterback to summary
public WritableRaster createCompatibleDestRaster(Raster src)

Implements java.awt.image.RasterOp.createCompatibleDestRaster.

Creates a zeroed-destination Raster with the correct size and number of bands, given this source.

Parameters
src:Raster

the Raster to be transformed

Returns:WritableRaster

the zeroed-destination Raster.

filterback to summary
public final BufferedImage filter(BufferedImage src, BufferedImage dst)

Implements java.awt.image.BufferedImageOp.filter.

Performs a lookup operation on a BufferedImage. If the color model in the source image is not the same as that in the destination image, the pixels will be converted in the destination. If the destination image is null, a BufferedImage will be created with an appropriate ColorModel. An IllegalArgumentException might be thrown if the number of arrays in the LookupTable does not meet the restrictions stated in the class comment above, or if the source image has an IndexColorModel.

Parameters
src:BufferedImage

the BufferedImage to be filtered

dst:BufferedImage

the BufferedImage in which to store the results of the filter operation

Returns:BufferedImage

the filtered BufferedImage.

Exceptions
IllegalArgumentException:
if the number of arrays in the LookupTable does not meet the restrictions described in the class comments, or if the source image has an IndexColorModel.
filterback to summary
public final WritableRaster filter(Raster src, WritableRaster dst)

Implements java.awt.image.RasterOp.filter.

Performs a lookup operation on a Raster. If the destination Raster is null, a new Raster will be created. The IllegalArgumentException might be thrown if the source Raster and the destination Raster do not have the same number of bands or if the number of arrays in the LookupTable does not meet the restrictions stated in the class comment above.

Parameters
src:Raster

the source Raster to filter

dst:WritableRaster

the destination WritableRaster for the filtered src

Returns:WritableRaster

the filtered WritableRaster.

Exceptions
IllegalArgumentException:
if the source and destinations rasters do not have the same number of bands, or the number of arrays in the LookupTable does not meet the restrictions described in the class comments.
getBounds2Dback to summary
public final Rectangle2D getBounds2D(BufferedImage src)

Implements java.awt.image.BufferedImageOp.getBounds2D.

Returns the bounding box of the filtered destination image. Since this is not a geometric operation, the bounding box does not change.

Parameters
src:BufferedImage

the BufferedImage to be filtered

Returns:Rectangle2D

the bounds of the filtered definition image.

getBounds2Dback to summary
public final Rectangle2D getBounds2D(Raster src)

Implements java.awt.image.RasterOp.getBounds2D.

Returns the bounding box of the filtered destination Raster. Since this is not a geometric operation, the bounding box does not change.

Parameters
src:Raster

the Raster to be filtered

Returns:Rectangle2D

the bounds of the filtered definition Raster.

getPoint2Dback to summary
public final Point2D getPoint2D(Point2D srcPt, Point2D dstPt)

Implements java.awt.image.BufferedImageOp.getPoint2D, java.awt.image.RasterOp.getPoint2D.

Returns the location of the destination point given a point in the source. If dstPt is not null, it will be used to hold the return value. Since this is not a geometric operation, the srcPt will equal the dstPt.

Parameters
srcPt:Point2D

a Point2D that represents a point in the source image

dstPt:Point2D

a Point2D that represents the location in the destination

Returns:Point2D

the Point2D in the destination that corresponds to the specified point in the source.

getRenderingHintsback to summary
public final RenderingHints getRenderingHints()

Implements java.awt.image.BufferedImageOp.getRenderingHints, java.awt.image.RasterOp.getRenderingHints.

Returns the rendering hints for this op.

Returns:RenderingHints

the RenderingHints object associated with this op.

getTableback to summary
public final LookupTable getTable()

Returns the LookupTable.

Returns:LookupTable

the LookupTable of this LookupOp.

shortFilterback to summary
private void shortFilter(ShortLookupTable lookup, Raster src, WritableRaster dst, int width, int height, int numBands)