com.alkacon.simapi.filter

Class ConvolveFilter

java.lang.Object

java.awt.image.ImageFilter

com.alkacon.simapi.filter.WholeImageFilter

com.alkacon.simapi.filter.ConvolveFilter

All Implemented Interfaces:

java.awt.image.ImageConsumer, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AverageFilter, BlurFilter, BumpFilter, GaussianFilter, SharpenFilter

public class ConvolveFilter
extends WholeImageFilter

A filter which applies a convolution kernel to an image.

Author:

Jerry Huxtable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	alpha
protected Kernel	kernel

Fields inherited from class com.alkacon.simapi.filter.WholeImageFilter

canFilterIndexColorModel, defaultRGBModel, inBytePixels, inPixels, originalSpace, transformedSpace

Fields inherited from class java.awt.image.ImageFilter

consumer

Fields inherited from interface java.awt.image.ImageConsumer

COMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT

Constructor Summary

Constructors

Constructor and Description
ConvolveFilter() Construct a filter with a null kernel.
ConvolveFilter(float[] matrix) Construct a filter with the given 3x3 kernel.
ConvolveFilter(int rows, int cols, float[] matrix) Construct a filter with the given kernel.
ConvolveFilter(Kernel kernel) Construct a filter with the given 3x3 kernel.

Method Summary

Modifier and Type	Method and Description
static void	convolve(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height)
static void	convolve(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha)
static void	convolveH(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha) Convolve with a kernel consisting of one row
static void	convolveHV(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha) Convolve with a 2D kernel
static void	convolveV(Kernel kernel, int[] inPixels, int[] outPixels, int width, int height, boolean alpha) Convolve with a kernel consisting of one column
Kernel	getKernel()
void	imageComplete(int status)
void	setKernel(Kernel kernel)
java.lang.String	toString()

Methods inherited from class com.alkacon.simapi.filter.WholeImageFilter

getTransformedSpace, setColorModel, setDimensions, setPixels, setPixels, transformSpace

Methods inherited from class java.awt.image.ImageFilter

clone, getFilterInstance, resendTopDownLeftRight, setHints, setProperties

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

kernel

protected Kernel kernel

alpha

public boolean alpha

Constructor Detail

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 - an array of 9 floats containing the kernel

Method Detail

convolve

public static void convolve(Kernel kernel,
                            int[] inPixels,
                            int[] outPixels,
                            int width,
                            int height)

convolve

public static void convolve(Kernel kernel,
                            int[] inPixels,
                            int[] outPixels,
                            int width,
                            int height,
                            boolean alpha)

convolveH

public static void convolveH(Kernel kernel,
                             int[] inPixels,
                             int[] outPixels,
                             int width,
                             int height,
                             boolean alpha)

Convolve with a kernel consisting of one row

convolveHV

public static void convolveHV(Kernel kernel,
                              int[] inPixels,
                              int[] outPixels,
                              int width,
                              int height,
                              boolean alpha)

Convolve with a 2D kernel

convolveV

public static void convolveV(Kernel kernel,
                             int[] inPixels,
                             int[] outPixels,
                             int width,
                             int height,
                             boolean alpha)

Convolve with a kernel consisting of one column

getKernel

public Kernel getKernel()

imageComplete

public void imageComplete(int status)

Specified by:

imageComplete in interface java.awt.image.ImageConsumer

Overrides:

imageComplete in class java.awt.image.ImageFilter

setKernel

public void setKernel(Kernel kernel)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object