java.awt.image

Class BandCombineOp

java.lang.Object

java.awt.image.BandCombineOp

All Implemented Interfaces:

RasterOp

public class BandCombineOp
extends java.lang.Object
implements RasterOp

Filter Raster pixels by applying a matrix. BandCombineOp applies a matrix to each pixel to produce new pixel values. The width of the matrix must be the same or one more than the number of bands in the source Raster. If one more, the pixels in the source are assumed to contain an implicit 1.0 at the end. The rows of the matrix are multiplied by the pixel to produce the values for the destination. Therefore the destination Raster must contain the same number of bands as the number of rows in the filter matrix. This Op assumes that samples are integers; floating point sample types will be rounded to their nearest integer value during filtering.

Constructor Summary

Constructors

Constructor and Description
BandCombineOp(float[][] matrix, java.awt.RenderingHints hints) Construct a BandCombineOp.

Method Summary

Methods

Modifier and Type	Method and Description
WritableRaster	createCompatibleDestRaster(Raster src) Creates a new WritableRaster that can be used as the destination for this Op.
WritableRaster	filter(Raster src, WritableRaster dest) Filter Raster pixels through a matrix.
java.awt.geom.Rectangle2D	getBounds2D(Raster src) Returns the bounds of the destination raster on the basis of this RasterOp being applied to the specified source raster.
float[][]	getMatrix() Return the matrix used in this operation.
java.awt.geom.Point2D	getPoint2D(java.awt.geom.Point2D src, java.awt.geom.Point2D dst) Return corresponding destination point for source point.
java.awt.RenderingHints	getRenderingHints() Returns the rendering hints for this operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

BandCombineOp

public BandCombineOp(float[][] matrix,
             java.awt.RenderingHints hints)

Construct a BandCombineOp.

Parameters:

matrix - The matrix to filter pixels with.

hints - Rendering hints to apply. Ignored.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the matrix is invalid

Method Detail

filter

public WritableRaster filter(Raster src,
                    WritableRaster dest)

Filter Raster pixels through a matrix. Applies the Op matrix to source pixes to produce dest pixels. Each row of the matrix is multiplied by the src pixel components to produce the dest pixel. If matrix is one more than the number of bands in the src, the last element is implicitly multiplied by 1, i.e. added to the sum for that dest component. If dest is null, a suitable Raster is created. This implementation uses createCompatibleDestRaster.

Specified by:

filter in interface RasterOp

Parameters:

src - The source Raster.

dest - The destination Raster, or null.

Returns:

The filtered Raster.

Throws:

java.lang.IllegalArgumentException - if the destination raster is incompatible with the source raster.

See Also:

RasterOp.filter(java.awt.image.Raster, java.awt.image.WritableRaster)

getBounds2D

public final java.awt.geom.Rectangle2D getBounds2D(Raster src)

Description copied from interface: RasterOp

Returns the bounds of the destination raster on the basis of this RasterOp being applied to the specified source raster.

Specified by:

getBounds2D in interface RasterOp

Parameters:

src - the source raster.

Returns:

The destination bounds.

createCompatibleDestRaster

public WritableRaster createCompatibleDestRaster(Raster src)

Creates a new WritableRaster that can be used as the destination for this Op. The number of bands in the source raster must equal the number of rows in the op matrix, which must also be equal to either the number of columns or (columns - 1) in the matrix.

Specified by:

createCompatibleDestRaster in interface RasterOp

Parameters:

src - The source raster.

Returns:

A compatible raster.

Throws:

java.lang.IllegalArgumentException - if the raster is incompatible with the matrix.

See Also:

RasterOp.createCompatibleDestRaster(java.awt.image.Raster)

getPoint2D

public final java.awt.geom.Point2D getPoint2D(java.awt.geom.Point2D src,
                               java.awt.geom.Point2D dst)

Return corresponding destination point for source point. Because this is not a geometric operation, it simply returns a copy of the source.

Specified by:

getPoint2D in interface RasterOp

Parameters:

src - The source point.

dst - The destination point.

Returns:

dst The destination point.

See Also:

RasterOp.getPoint2D(java.awt.geom.Point2D, java.awt.geom.Point2D)

getRenderingHints

public final java.awt.RenderingHints getRenderingHints()

Description copied from interface: RasterOp

Returns the rendering hints for this operation.

Specified by:

getRenderingHints in interface RasterOp

Returns:

The rendering hints.

getMatrix

public final float[][] getMatrix()

Return the matrix used in this operation.

Returns:

The matrix used in this operation.