Prev Class | Next Class | Frames | No Frames |

Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |

`java.lang.Object`

`java.awt.image.BandCombineOp`

**Implemented Interfaces:**- 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

`BandCombineOp(float[][] matrix, RenderingHints hints)`

- Construct a BandCombineOp.

## Method Summary

`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.

`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.

`Point2D`

`getPoint2D(Point2D src, Point2D dst)`

- Return corresponding destination point for source point.

`RenderingHints`

`getRenderingHints()`

- Returns the rendering hints for this operation.

### Methods inherited from class java.lang.Object

`clone`

,`equals`

,`extends Object> getClass`

,`finalize`

,`hashCode`

,`notify`

,`notifyAll`

,`toString`

,`wait`

,`wait`

,`wait`

public BandCombineOp(float[][] matrix, RenderingHints hints)

Construct a BandCombineOp.

Parameters:`matrix`

- The matrix to filter pixels with.`hints`

- Rendering hints to apply. Ignored.

Throws:`ArrayIndexOutOfBoundsException`

- if the matrix is invalid

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:`IllegalArgumentException`

- if the raster is incompatible with the matrix.

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.

Parameters:`src`

- The source Raster.`dest`

- The destination Raster, or null.

Returns:- The filtered Raster.

Throws:`IllegalArgumentException`

- if the destination raster is incompatible with the source raster.

public final Rectangle2D getBounds2D(Raster src)

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.

public final float[][] getMatrix()

Return the matrix used in this operation.

Returns:- The matrix used in this operation.

public final Point2D getPoint2D(Point2D src, 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(Point2D,Point2D)`

public final RenderingHints getRenderingHints()

Returns the rendering hints for this operation.

Specified by:- getRenderingHints in interface RasterOp

Returns:- The rendering hints.

BandCombineOp.java - perform a combination on the bands of a raster
Copyright (C) 2004, 2006 Free Software Foundation
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.