All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.image.ConvolveOp 

java.lang.Object
    |
    +----java.awt.image.ConvolveOp
public class ConvolveOp
extends Object
implements BufferedImageOp, RasterOp
This class implements a convolution from the source to the destination. Convolution using a convolution kernel is a spatial operation that computes the output pixel from an input pixel by multiplying the kernel with the surround of the input pixel. This allows the output pixel to be affected by the immediate neighborhood in a way that can be mathematically specified with a kernel.

This class operates with BufferedImage data that are premultiplied with alpha. If the Source BufferedImage has an alpha component, and the color components are not premultiplied with the alpha component, then the data are premultiplied before being convolved. If the Destination has alpha components which are not premultiplied, then alpha is divided out before storing into the Destination. If the Destination has no alpha component, then the resulting alpha is discarded after first dividing it out of the color components.

Rasters are treated as having no alpha channel.

Note that the Source and the Destination may not be the same object.

See Also:
Kernel

Variable Index

o EDGE_NO_OP
Pixels at the edge of the source image are copied to the corresponding pixels in the destination without modification.
o EDGE_ZERO_FILL
Pixels at the edge of the destination image are set to zero.

Constructor Index

o ConvolveOp(Kernel)
Constructs a ConvolveOp given a Kernel.
o ConvolveOp(Kernel, int)
Constructs a ConvolveOp given a Kernel and an edge hint.

Method Index

o createCompatibleDestImage(BufferedImage, ColorModel)
Creates an empty destination image with the correct size and number of channels.
o createCompatibleDestRaster(Raster)
Creates an empty destination Raster with the correct size and number of channels.
o filter(BufferedImage, BufferedImage)
Perform a convolution on BufferedImages.
o filter(Raster, WritableRaster)
Perform a convolution on Rasters.
o getDestBounds(BufferedImage)
Returns the bounding box of the filtered destination image.
o getDestBounds(Raster)
Returns the bounding box of the filtered destination Raster.
o getDestPoint(Point2D, Point2D)
Returns the location of the destination point given a point in the source image.
o getEdgeHint()
Return the edge hint.
o getKernel()
Return the Kernel.

Variables

o EDGE_ZERO_FILL 
public static final int EDGE_ZERO_FILL
Pixels at the edge of the destination image are set to zero. This is the default.

o EDGE_NO_OP 
public static final int EDGE_NO_OP
Pixels at the edge of the source image are copied to the corresponding pixels in the destination without modification.

Constructors

o ConvolveOp 
public ConvolveOp(Kernel kernel,
                  int edgeHint)
Constructs a ConvolveOp given a Kernel and an edge hint.

See Also:
Kernel, EDGE_NO_OP, EDGE_ZERO_FILL
o ConvolveOp 
public ConvolveOp(Kernel kernel)
Constructs a ConvolveOp given a Kernel. The edge hint will be EDGE_ZERO_FILL.

See Also:
Kernel, EDGE_ZERO_FILL

Methods

o getEdgeHint 
public int getEdgeHint()
Return the edge hint.

See Also:
EDGE_NO_OP, EDGE_ZERO_FILL
o getKernel 
public Kernel getKernel()
Return the Kernel.

o filter 
public BufferedImage filter(BufferedImage src,
                            BufferedImage dst)
Perform a convolution on BufferedImages. Each component of the source image will be convolved. 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 the source ColorModel. The IllegalArgumentException may be thrown if the source is the same as the destination.

o filter 
public WritableRaster filter(Raster src,
                             WritableRaster dst)
Perform a convolution on Rasters. Each channel of the source Raster will be convolved. The source and destination must have the same number of channels. If the destination Raster is null, a new Raster will be created. The IllegalArgumentException may be thrown if the source is the same as the destination.

o createCompatibleDestImage 
public BufferedImage createCompatibleDestImage(BufferedImage src,
                                               ColorModel destCM)
Creates an empty destination image with the correct size and number of channels.

Parameters:
src - Source image for the filter operation
destCM - ColorModel of the destination. Can be null.
o createCompatibleDestRaster 
public WritableRaster createCompatibleDestRaster(Raster src)
Creates an empty destination Raster with the correct size and number of channels.

o getDestBounds 
public Rectangle2D getDestBounds(BufferedImage src)
Returns the bounding box of the filtered destination image. Since this is not a geometric operation, the bounding box does not change.

o getDestBounds 
public Rectangle2D getDestBounds(Raster src)
Returns the bounding box of the filtered destination Raster. Since this is not a geometric operation, the bounding box does not change.

o getDestPoint 
public Point2D getDestPoint(Point2D srcPt,
                            Point2D dstPt)
Returns the location of the destination point given a point in the source image. If dstPt is non-null, it will be used to hold the return value. Since this is not a geometric operation, the srcPt will equal the dstPt. 

All Packages  Class Hierarchy  This Package  Previous  Next  Index
Submit a bug or feature