- All Implemented Interfaces:
BufferedImageOp,RasterOp
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
FieldsModifier and TypeFieldDescriptionstatic final intPixels at the edge of the source image are copied to the corresponding pixels in the destination without modification.static final intPixels at the edge of the destination image are set to zero. -
Constructor Summary
ConstructorsConstructorDescriptionConvolveOp(Kernel kernel) Constructs a ConvolveOp given a Kernel.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 Summary
Modifier and TypeMethodDescriptioncreateCompatibleDestImage(BufferedImage src, ColorModel destCM) Creates a zeroed destination image with the correct size and number of bands.Creates a zeroed destination Raster with the correct size and number of bands, given this source.final BufferedImagefilter(BufferedImage src, BufferedImage dst) Performs a convolution on BufferedImages.final WritableRasterfilter(Raster src, WritableRaster dst) Performs a convolution on Rasters.final Rectangle2DgetBounds2D(BufferedImage src) Returns the bounding box of the filtered destination image.final Rectangle2DgetBounds2D(Raster src) Returns the bounding box of the filtered destination Raster.intReturns the edge condition.final KernelReturns the Kernel.final Point2DgetPoint2D(Point2D srcPt, Point2D dstPt) Returns the location of the destination point given a point in the source.final RenderingHintsReturns the rendering hints for this op.
-
Field Details
-
EDGE_ZERO_FILL
Pixels at the edge of the destination image are set to zero. This is the default.- See Also:
-
EDGE_NO_OP
Pixels at the edge of the source image are copied to the corresponding pixels in the destination without modification.- See Also:
-
-
Constructor Details
-
ConvolveOp
Constructs a ConvolveOp given a Kernel, an edge condition, and a RenderingHints object (which may be null).- Parameters:
kernel- the specifiedKerneledgeCondition- the specified edge conditionhints- the specifiedRenderingHintsobject- See Also:
-
ConvolveOp
Constructs a ConvolveOp given a Kernel. The edge condition will be EDGE_ZERO_FILL.- Parameters:
kernel- the specifiedKernel- See Also:
-
-
Method Details
-
getEdgeCondition
public int getEdgeCondition()Returns the edge condition.- Returns:
- the edge condition of this
ConvolveOp. - See Also:
-
getKernel
Returns the Kernel.- Returns:
- the
Kernelof thisConvolveOp.
-
filter
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.- Specified by:
filterin interfaceBufferedImageOp- Parameters:
src- the sourceBufferedImageto filterdst- the destinationBufferedImagefor the filteredsrc- Returns:
- the filtered
BufferedImage - Throws:
NullPointerException- ifsrcisnullIllegalArgumentException- ifsrcequalsdstImagingOpException- ifsrccannot be filtered
-
filter
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.- Specified by:
filterin interfaceRasterOp- Parameters:
src- the sourceRasterto filterdst- the destinationWritableRasterfor the filteredsrc- Returns:
- the filtered
WritableRaster - Throws:
NullPointerException- ifsrcisnullImagingOpException- ifsrcanddstdo not have the same number of bandsImagingOpException- ifsrccannot be filteredIllegalArgumentException- ifsrcequalsdst
-
createCompatibleDestImage
Creates a zeroed destination image with the correct size and number of bands. If destCM is null, an appropriate ColorModel will be used.- Specified by:
createCompatibleDestImagein interfaceBufferedImageOp- Parameters:
src- Source image for the filter operation.destCM- ColorModel of the destination. Can be null.- Returns:
- a destination
BufferedImagewith the correct size and number of bands.
-
createCompatibleDestRaster
Creates a zeroed destination Raster with the correct size and number of bands, given this source.- Specified by:
createCompatibleDestRasterin interfaceRasterOp- Parameters:
src- the sourceRaster- Returns:
- a
WritableRasterthat is compatible withsrc
-
getBounds2D
Returns the bounding box of the filtered destination image. Since this is not a geometric operation, the bounding box does not change.- Specified by:
getBounds2Din interfaceBufferedImageOp- Parameters:
src- TheBufferedImageto be filtered- Returns:
- The
Rectangle2Drepresenting the destination image's bounding box.
-
getBounds2D
Returns the bounding box of the filtered destination Raster. Since this is not a geometric operation, the bounding box does not change.- Specified by:
getBounds2Din interfaceRasterOp- Parameters:
src- the sourceRaster- Returns:
- a
Rectangle2Dthat is the bounding box of theRasterresulting from the filtering operation.
-
getPoint2D
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.- Specified by:
getPoint2Din interfaceBufferedImageOp- Specified by:
getPoint2Din interfaceRasterOp- Parameters:
srcPt- thePoint2Dthat represents the point in the source imagedstPt- ThePoint2Din which to store the result- Returns:
- The
Point2Din the destination image that corresponds to the specified point in the source image.
-
getRenderingHints
Returns the rendering hints for this op.- Specified by:
getRenderingHintsin interfaceBufferedImageOp- Specified by:
getRenderingHintsin interfaceRasterOp- Returns:
- The
RenderingHintsobject for thisBufferedImageOp. Returns null if no hints have been set.
-