java.awt.image

Class ConvolveOp

Implemented Interfaces:
BufferedImageOp, RasterOp

public class ConvolveOp
extends Object
implements BufferedImageOp, RasterOp

Convolution filter. ConvolveOp convolves the source image with a Kernel to generate a destination image. This involves multiplying each pixel and its neighbors with elements in the kernel to compute a new pixel. Each band in a Raster is convolved and copied to the destination Raster. For BufferedImages, convolution is applied to all components. If the source is not premultiplied, the data will be premultiplied before convolving. Premultiplication will be undone if the destination is not premultiplied. Color conversion will be applied if needed.

Field Summary

static int
EDGE_NO_OP
Edge pixels are copied from the source.
static int
EDGE_ZERO_FILL
Edge pixels are set to 0.

Constructor Summary

ConvolveOp(Kernel kernel)
Construct a ConvolveOp.
ConvolveOp(Kernel kernel, int edgeCondition, RenderingHints hints)
Construct a ConvolveOp.

Method Summary

BufferedImage
createCompatibleDestImage(BufferedImage src, ColorModel dstCM)
WritableRaster
createCompatibleDestRaster(Raster src)
Returns a raster that can be used by this RasterOp as the destination raster when operating on the specified source raster.
BufferedImage
filter(BufferedImage src, BufferedImage dst)
WritableRaster
filter(Raster src, WritableRaster dest)
Performs an operation on the source raster, returning the result in a writable raster.
Rectangle2D
getBounds2D(BufferedImage src)
Rectangle2D
getBounds2D(Raster src)
Returns the bounds of the destination raster on the basis of this RasterOp being applied to the specified source raster.
int
getEdgeCondition()
Kernel
getKernel()
Returns (a clone of) the convolution kernel.
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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EDGE_NO_OP

public static final int EDGE_NO_OP
Edge pixels are copied from the source.
Field Value:
1

EDGE_ZERO_FILL

public static final int EDGE_ZERO_FILL
Edge pixels are set to 0.
Field Value:
0

Constructor Details

ConvolveOp

public ConvolveOp(Kernel kernel)
Construct a ConvolveOp. The edge condition defaults to EDGE_ZERO_FILL.
Parameters:
kernel - The kernel to convolve with.

ConvolveOp

public ConvolveOp(Kernel kernel,
                  int edgeCondition,
                  RenderingHints hints)
Construct a ConvolveOp. The edge condition specifies that pixels outside the area that can be filtered are either set to 0 or copied from the source image.
Parameters:
kernel - The kernel to convolve with.
edgeCondition - Either EDGE_ZERO_FILL or EDGE_NO_OP.
hints - Rendering hints for color conversion, or null.

Method Details

createCompatibleDestImage

public BufferedImage createCompatibleDestImage(BufferedImage src,
                                               ColorModel dstCM)
Specified by:
createCompatibleDestImage in interface BufferedImageOp

createCompatibleDestRaster

public WritableRaster createCompatibleDestRaster(Raster src)
Returns a raster that can be used by this RasterOp as the destination raster when operating on the specified source raster.
Specified by:
createCompatibleDestRaster in interface RasterOp
Parameters:
src - the source raster.
Returns:
A new writable raster that can be used as the destination raster.

filter

public final BufferedImage filter(BufferedImage src,
                                  BufferedImage dst)
Specified by:
filter in interface BufferedImageOp

filter

public final WritableRaster filter(Raster src,
                                   WritableRaster dest)
Performs an operation on the source raster, returning the result in a writable raster. If dest is null, a new WritableRaster will be created by calling the RasterOp.createCompatibleDestRaster(Raster) method. If dest is not null, the result is written to dest then returned (this avoids creating a new WritableRaster each time this method is called).
Specified by:
filter in interface RasterOp
Parameters:
src - the source raster.
dest - the destination raster (null permitted).
Returns:
The filtered raster.

getBounds2D

public final Rectangle2D getBounds2D(BufferedImage src)
Specified by:
getBounds2D in interface BufferedImageOp

getBounds2D

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.

getEdgeCondition

public int getEdgeCondition()
Returns:
The edge condition.

getKernel

public final Kernel getKernel()
Returns (a clone of) the convolution kernel.
Returns:
The convolution kernel.

getPoint2D

public final Point2D getPoint2D(Point2D src,
                                Point2D dst)
Return corresponding destination point for source point. ConvolveOp will return the value of src unchanged.
Specified by:
getPoint2D in interface BufferedImageOp
getPoint2D in interface RasterOp
Parameters:
src - The source point.
dst - The destination point.

getRenderingHints

public final RenderingHints getRenderingHints()
Returns the rendering hints for this operation.
Specified by:
getRenderingHints in interface BufferedImageOp
getRenderingHints in interface RasterOp
Returns:
The rendering hints.

ConvolveOp.java -- Copyright (C) 2004, 2005, 2006, Free Software Foundation -- ConvolveOp 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.