OpenJDK 1.22 · java.awt.image.BandCombineOp

This class performs an arbitrary linear combination of the bands in a Raster, using a specified matrix.

The width of the matrix must be equal to the number of bands in the source Raster, optionally plus one. If there is one more column in the matrix than the number of bands, there is an implied 1 at the end of the vector of band samples representing a pixel. The height of the matrix must be equal to the number of bands in the destination.

For example, a 3-banded Raster might have the following transformation applied to each pixel in order to invert the second band of the Raster.

  [ 1.0   0.0   0.0    0.0  ]     [ b1 ]
  [ 0.0  -1.0   0.0  255.0  ]  x  [ b2 ]
  [ 0.0   0.0   1.0    0.0  ]     [ b3 ]
                                  [ 1 ]

Note that the source and destination can be the same object.

Modifier and Type	Field and Description
pack-priv RenderingHints	hints
pack-priv float[][]	matrix
pack-priv int	ncols
pack-priv int	nrows

Constructor Summary

Access	Constructor and Description
public	BandCombineOp(float[][] The matrix to use for the band combine operation. matrix, RenderingHints The `RenderingHints` object for this operation. Not currently used so it can be null. hints) Constructs a `BandCombineOp` with the specified matrix.

Method Summary

Modifier and Type	Method and Description
public WritableRaster	Returns: The zeroed destination `Raster`. createCompatibleDestRaster(Raster The `Raster` to be filtered. src) Implements java.awt.image.RasterOp.createCompatibleDestRaster. Creates a zeroed destination `Raster` with the correct size and number of bands.
public WritableRaster	Returns: The filtered `Raster`. filter(Raster The `Raster` to be filtered. src, WritableRaster The `Raster` in which to store the results of the filter operation. dst) Implements java.awt.image.RasterOp.filter. Transforms the `Raster` using the matrix specified in the constructor.
public final Rectangle2D	Returns: The `Rectangle2D` representing the destination image's bounding box. getBounds2D(Raster The `Raster` to be filtered. src) Implements java.awt.image.RasterOp.getBounds2D. Returns the bounding box of the transformed destination.
public final float[][]	Returns: The matrix associated with this band combine operation. getMatrix() Returns a copy of the linear combination matrix.
public final Point2D	Returns: The `Point2D` in the destination image that corresponds to the specified point in the source image. getPoint2D(Point2D The `Point2D` that represents the point in the source `Raster` srcPt, Point2D The `Point2D` in which to store the result. dstPt) Implements java.awt.image.RasterOp.getPoint2D. Returns the location of the corresponding destination point given a point in the source `Raster`.
public final RenderingHints	Returns: The `RenderingHints` object associated with this operation. Returns null if no hints have been set. getRenderingHints() Implements java.awt.image.RasterOp.getRenderingHints. Returns the rendering hints for this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

hints	back to summary
pack-priv RenderingHints hints

matrix	back to summary
pack-priv float[][] matrix

ncols	back to summary
pack-priv int ncols

nrows	back to summary
pack-priv int nrows

Constructor Detail

BandCombineOp back to summary

BandCombineOp	back to summary
public BandCombineOp(float[][] matrix, RenderingHints hints) Constructs a `BandCombineOp` with the specified matrix. The width of the matrix must be equal to the number of bands in the source `Raster`, optionally plus one. If there is one more column in the matrix than the number of bands, there is an implied 1 at the end of the vector of band samples representing a pixel. The height of the matrix must be equal to the number of bands in the destination. The first subscript is the row index and the second is the column index. This operation uses none of the currently defined rendering hints; the `RenderingHints` argument can be null. Parameters matrix:float[][] The matrix to use for the band combine operation. hints:RenderingHints The `RenderingHints` object for this operation. Not currently used so it can be null.

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

Constructs a BandCombineOp with the specified matrix. The width of the matrix must be equal to the number of bands in the source Raster, optionally plus one. If there is one more column in the matrix than the number of bands, there is an implied 1 at the end of the vector of band samples representing a pixel. The height of the matrix must be equal to the number of bands in the destination.

The first subscript is the row index and the second is the column index. This operation uses none of the currently defined rendering hints; the RenderingHints argument can be null.

Parameters

matrix:float[][]: The matrix to use for the band combine operation.
hints:RenderingHints: The RenderingHints object for this operation. Not currently used so it can be null.

Method Detail

createCompatibleDestRaster back to summary

createCompatibleDestRaster	back 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. An `IllegalArgumentException` may be thrown if the number of bands in the source is incompatible with the matrix. See the class comments for more details. Parameters src:Raster The `Raster` to be filtered. Returns:WritableRaster The zeroed destination `Raster`.

public WritableRaster createCompatibleDestRaster(Raster src)

Implements java.awt.image.RasterOp.createCompatibleDestRaster.

Creates a zeroed destination Raster with the correct size and number of bands. An IllegalArgumentException may be thrown if the number of bands in the source is incompatible with the matrix. See the class comments for more details.

Parameters

src:Raster: The Raster to be filtered.

Returns:WritableRaster

The zeroed destination Raster.

filter back to summary

filter	back to summary
public WritableRaster filter(Raster src, WritableRaster dst) Implements java.awt.image.RasterOp.filter. Transforms the `Raster` using the matrix specified in the constructor. An `IllegalArgumentException` may be thrown if the number of bands in the source or destination is incompatible with the matrix. See the class comments for more details. If the destination is null, it will be created with a number of bands equalling the number of rows in the matrix. No exception is thrown if the operation causes a data overflow. Parameters src:Raster The `Raster` to be filtered. dst:WritableRaster The `Raster` in which to store the results of the filter operation. Returns:WritableRaster The filtered `Raster`. Exceptions IllegalArgumentException: If the number of bands in the source or destination is incompatible with the matrix.

public WritableRaster filter(Raster src, WritableRaster dst)

Implements java.awt.image.RasterOp.filter.

Transforms the Raster using the matrix specified in the constructor. An IllegalArgumentException may be thrown if the number of bands in the source or destination is incompatible with the matrix. See the class comments for more details.

If the destination is null, it will be created with a number of bands equalling the number of rows in the matrix. No exception is thrown if the operation causes a data overflow.

Parameters

src:Raster: The Raster to be filtered.
dst:WritableRaster: The Raster in which to store the results of the filter operation.

Returns:WritableRaster

The filtered Raster.

Exceptions

IllegalArgumentException:: If the number of bands in the source or destination is incompatible with the matrix.

getBounds2D back to summary

getBounds2D	back to summary
public final Rectangle2D getBounds2D(Raster src) Implements java.awt.image.RasterOp.getBounds2D. Returns the bounding box of the transformed destination. Since this is not a geometric operation, the bounding box is the same for the source and destination. An `IllegalArgumentException` may be thrown if the number of bands in the source is incompatible with the matrix. See the class comments for more details. Parameters src:Raster The `Raster` to be filtered. Returns:Rectangle2D The `Rectangle2D` representing the destination image's bounding box. Exceptions IllegalArgumentException: If the number of bands in the source is incompatible with the matrix.

public final Rectangle2D getBounds2D(Raster src)

Implements java.awt.image.RasterOp.getBounds2D.

Returns the bounding box of the transformed destination. Since this is not a geometric operation, the bounding box is the same for the source and destination. An IllegalArgumentException may be thrown if the number of bands in the source is incompatible with the matrix. See the class comments for more details.

Parameters

src:Raster: The Raster to be filtered.

Returns:Rectangle2D

The Rectangle2D representing the destination image's bounding box.

Exceptions

IllegalArgumentException:: If the number of bands in the source is incompatible with the matrix.

getMatrix	back to summary
public final float[][] getMatrix() Returns a copy of the linear combination matrix. Returns:float[][] The matrix associated with this band combine operation.

getMatrix

back to summary

public final float[][] getMatrix()

Returns a copy of the linear combination matrix.

Returns:float[][]: The matrix associated with this band combine operation.

getPoint2D back to summary

getPoint2D	back to summary
public final Point2D getPoint2D(Point2D srcPt, Point2D dstPt) Implements java.awt.image.RasterOp.getPoint2D. Returns the location of the corresponding destination point given a point in the source `Raster`. If `dstPt` is specified, it is used to hold the return value. Since this is not a geometric operation, the point returned is the same as the specified `srcPt`. Parameters srcPt:Point2D The `Point2D` that represents the point in the source `Raster` dstPt:Point2D The `Point2D` in which to store the result. Returns:Point2D The `Point2D` in the destination image that corresponds to the specified point in the source image.

public final Point2D getPoint2D(Point2D srcPt, Point2D dstPt)

Implements java.awt.image.RasterOp.getPoint2D.

Returns the location of the corresponding destination point given a point in the source Raster. If dstPt is specified, it is used to hold the return value. Since this is not a geometric operation, the point returned is the same as the specified srcPt.

Parameters

srcPt:Point2D: The Point2D that represents the point in the source Raster
dstPt:Point2D: The Point2D in which to store the result.

Returns:Point2D

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

getRenderingHints back to summary

getRenderingHints	back to summary
public final RenderingHints getRenderingHints() Implements java.awt.image.RasterOp.getRenderingHints. Returns the rendering hints for this operation. Returns:RenderingHints The `RenderingHints` object associated with this operation. Returns null if no hints have been set.

public final RenderingHints getRenderingHints()

Implements java.awt.image.RasterOp.getRenderingHints.

Returns the rendering hints for this operation.

Returns:RenderingHints: The RenderingHints object associated with this operation. Returns null if no hints have been set.

public Class BandCombineOp

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail