Home » openjdk-7 » java » awt » image » [javadoc | source]
java.awt.image
public class: ConvolveOp [javadoc | source]
java.lang.Object
   java.awt.image.ConvolveOp

All Implemented Interfaces:
    RasterOp, BufferedImageOp

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 in which color components are premultiplied with the alpha component. 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 color components which are not premultiplied, then alpha is divided out before storing into the Destination (if alpha is 0, the color components are set to 0). 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. If the above treatment of the alpha channel in BufferedImages is not desired, it may be avoided by getting the Raster of a source BufferedImage and using the filter method of this class which works with Rasters.

If a RenderingHints object is specified in the constructor, the color rendering hint and the dithering hint may be used when color conversion is required.

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

Field Summary
 Kernel kernel     
 int edgeHint     
 RenderingHints hints     
public static final  int EDGE_ZERO_FILL    Pixels at the edge of the destination image are set to zero. This is the default. 
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. 
Constructor:
 public ConvolveOp(Kernel kernel) 
    Constructs a ConvolveOp given a Kernel. The edge condition will be EDGE_ZERO_FILL.
 public ConvolveOp(Kernel kernel,
    int edgeCondition,
    RenderingHints hints) 
    Constructs a ConvolveOp given a Kernel, an edge condition, and a RenderingHints object (which may be null).
Method from java.awt.image.ConvolveOp Summary:
createCompatibleDestImage,   createCompatibleDestRaster,   filter,   filter,   getBounds2D,   getBounds2D,   getEdgeCondition,   getKernel,   getPoint2D,   getRenderingHints
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.image.ConvolveOp Detail:
 public BufferedImage createCompatibleDestImage(BufferedImage src,
    ColorModel destCM) 
    Creates a zeroed destination image with the correct size and number of bands. If destCM is null, an appropriate ColorModel will be used.
 public WritableRaster createCompatibleDestRaster(Raster src) 
    Creates a zeroed destination Raster with the correct size and number of bands, given this source.
 public final BufferedImage filter(BufferedImage src,
    BufferedImage dst) 
    Performs a convolution on BufferedImages. Each component of the source image will be convolved (including the alpha component, if present). 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.
 public final WritableRaster filter(Raster src,
    WritableRaster dst) 
    Performs a convolution on Rasters. Each band of the source Raster will be convolved. The source and destination must have the same number of bands. 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.
 public final Rectangle2D getBounds2D(BufferedImage src) 
    Returns the bounding box of the filtered destination image. Since this is not a geometric operation, the bounding box does not change.
 public final Rectangle2D getBounds2D(Raster src) 
    Returns the bounding box of the filtered destination Raster. Since this is not a geometric operation, the bounding box does not change.
 public int getEdgeCondition() 
    Returns the edge condition.
 public final Kernel getKernel() 
    Returns the Kernel.
 public final Point2D getPoint2D(Point2D srcPt,
    Point2D dstPt) 
    Returns the location of the destination point given a point in the source. 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.
 public final RenderingHints getRenderingHints() 
    Returns the rendering hints for this op.