Package com.jhlabs.image

Class ConvolveFilter

java.lang.Object
com.jhlabs.image.AbstractBufferedImageOp
com.jhlabs.image.ConvolveFilter
All Implemented Interfaces:
BufferedImageOp, Cloneable
Direct Known Subclasses:
AverageFilter, BlurFilter, BumpFilter, GaussianFilter, SharpenFilter
public class ConvolveFilter extends AbstractBufferedImageOp
A filter which applies a convolution kernel to an image.

  • Field Details

    • ZERO_EDGES

      public static int ZERO_EDGES
      Treat pixels off the edge as zero.

    • CLAMP_EDGES

      public static int CLAMP_EDGES
      Clamp pixels off the edge to the nearest edge.

    • WRAP_EDGES

      public static int WRAP_EDGES
      Wrap pixels off the edge to the opposite edge.

    • kernel

      protected Kernel kernel
      The convolution kernel.

    • alpha

      protected boolean alpha
      Whether to convolve alpha.

    • premultiplyAlpha

      protected boolean premultiplyAlpha
      Whether to promultiply the alpha before convolving.

  • Constructor Details

    • ConvolveFilter

      public ConvolveFilter()
      Construct a filter with a null kernel. This is only useful if you're going to change the kernel later on.

    • ConvolveFilter

      public ConvolveFilter(float[] matrix)
      Construct a filter with the given 3x3 kernel.
      Parameters:
      matrix - an array of 9 floats containing the kernel

    • ConvolveFilter

      public ConvolveFilter(int rows, int cols, float[] matrix)
      Construct a filter with the given kernel.
      Parameters:
      rows - the number of rows in the kernel
      cols - the number of columns in the kernel
      matrix - an array of rows*cols floats containing the kernel

    • ConvolveFilter

      public ConvolveFilter(Kernel kernel)
      Construct a filter with the given 3x3 kernel.
      Parameters:
      kernel - the convolution kernel

  • Method Details

    • setKernel

      public void setKernel(Kernel kernel)
      Set the convolution kernel.
      Parameters:
      kernel - the kernel
      See Also:

    • getKernel

      public Kernel getKernel()
      Get the convolution kernel.
      Returns:
      the kernel
      See Also:

    • setEdgeAction

      public void setEdgeAction(int edgeAction)
      Set the action to perfomr for pixels off the image edges.
      Parameters:
      edgeAction - the action
      See Also:

    • getEdgeAction

      public int getEdgeAction()
      Get the action to perfomr for pixels off the image edges.
      Returns:
      the action
      See Also:

    • setUseAlpha

      public void setUseAlpha(boolean useAlpha)
      Set whether to convolve the alpha channel.
      Parameters:
      useAlpha - true to convolve the alpha
      See Also:

    • getUseAlpha

      public boolean getUseAlpha()
      Get whether to convolve the alpha channel.
      Returns:
      true to convolve the alpha
      See Also:

    • setPremultiplyAlpha

      public void setPremultiplyAlpha(boolean premultiplyAlpha)
      Set whether to premultiply the alpha channel.
      Parameters:
      premultiplyAlpha - true to premultiply the alpha
      See Also:

    • getPremultiplyAlpha

      public boolean getPremultiplyAlpha()
      Get whether to premultiply the alpha channel.
      Returns:
      true to premultiply the alpha
      See Also:

    • filter

      public BufferedImage filter(BufferedImage src, BufferedImage dst)

    • createCompatibleDestImage

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

    • getBounds2D

      public Rectangle2D getBounds2D(BufferedImage src)
      Specified by:
      getBounds2D in interface BufferedImageOp
      Overrides:
      getBounds2D in class AbstractBufferedImageOp

    • getPoint2D

      public Point2D getPoint2D(Point2D srcPt, Point2D dstPt)
      Specified by:
      getPoint2D in interface BufferedImageOp
      Overrides:
      getPoint2D in class AbstractBufferedImageOp

    • getRenderingHints

      public RenderingHints getRenderingHints()
      Specified by:
      getRenderingHints in interface BufferedImageOp
      Overrides:
      getRenderingHints in class AbstractBufferedImageOp

    • convolve

      public static void convolve(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, int edgeAction)
      Convolve a block of pixels.
      Parameters:
      kernel - the kernel
      inPixels - the input pixels
      outPixels - the output pixels
      width - the width
      height - the height
      edgeAction - what to do at the edges

    • convolve

      public static void convolve(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha, int edgeAction)
      Convolve a block of pixels.
      Parameters:
      kernel - the kernel
      inPixels - the input pixels
      outPixels - the output pixels
      width - the width
      height - the height
      alpha - include alpha channel
      edgeAction - what to do at the edges

    • convolveHV

      public static void convolveHV(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha, int edgeAction)
      Convolve with a 2D kernel.
      Parameters:
      kernel - the kernel
      inPixels - the input pixels
      outPixels - the output pixels
      width - the width
      height - the height
      alpha - include alpha channel
      edgeAction - what to do at the edges

    • convolveH

      public static void convolveH(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha, int edgeAction)
      Convolve with a kernel consisting of one row.
      Parameters:
      kernel - the kernel
      inPixels - the input pixels
      outPixels - the output pixels
      width - the width
      height - the height
      alpha - include alpha channel
      edgeAction - what to do at the edges

    • convolveV

      public static void convolveV(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha, int edgeAction)
      Convolve with a kernel consisting of one column.
      Parameters:
      kernel - the kernel
      inPixels - the input pixels
      outPixels - the output pixels
      width - the width
      height - the height
      alpha - include alpha channel
      edgeAction - what to do at the edges

    • toString

      public String toString()
      Overrides:
      toString in class Object