org.apache.batik.ext.awt.image.renderable

Interface ConvolveMatrixRable

public interface ConvolveMatrixRable extends FilterColorInterpolation

Convolves an image with a convolution matrix.
Method Summary
doublegetBias()
Returns the shift value to apply to the result of convolution
PadModegetEdgeMode()
Returns the current edge handling mode.
KernelgetKernel()
Returns the Convolution Kernel in use
double[]getKernelUnitLength()
Returns the [x,y] distance in user space between kernel values
booleangetPreserveAlpha()
Returns false if the convolution should affect the Alpha channel
FiltergetSource()
Returns the source to be Convolved
PointgetTarget()
Returns the target point of the kernel (what pixel under the kernel should be set to the result of convolution).
voidsetBias(double bias)
Sets the shift value to apply to the result of convolution
voidsetEdgeMode(PadMode edgeMode)
Sets the current edge handling mode.
voidsetKernel(Kernel k)
Sets the Convolution Kernel to use.
voidsetKernelUnitLength(double[] kernelUnitLength)
Sets the [x,y] distance in user space between kernel values If set to zero then one pixel in device space will be used.
voidsetPreserveAlpha(boolean preserveAlpha)
Sets Alpha channel handling.
voidsetSource(Filter src)
Sets the source to be Convolved
voidsetTarget(Point pt)
Sets the target point of the kernel (what pixel under the kernel should be set to the result of the convolution).

Method Detail

getBias

public double getBias()
Returns the shift value to apply to the result of convolution

getEdgeMode

public PadMode getEdgeMode()
Returns the current edge handling mode.

getKernel

public Kernel getKernel()
Returns the Convolution Kernel in use

getKernelUnitLength

public double[] getKernelUnitLength()
Returns the [x,y] distance in user space between kernel values

getPreserveAlpha

public boolean getPreserveAlpha()
Returns false if the convolution should affect the Alpha channel

getSource

public Filter getSource()
Returns the source to be Convolved

getTarget

public Point getTarget()
Returns the target point of the kernel (what pixel under the kernel should be set to the result of convolution).

setBias

public void setBias(double bias)
Sets the shift value to apply to the result of convolution

setEdgeMode

public void setEdgeMode(PadMode edgeMode)
Sets the current edge handling mode.

setKernel

public void setKernel(Kernel k)
Sets the Convolution Kernel to use.

Parameters: k Kernel to use for convolution.

setKernelUnitLength

public void setKernelUnitLength(double[] kernelUnitLength)
Sets the [x,y] distance in user space between kernel values If set to zero then one pixel in device space will be used.

setPreserveAlpha

public void setPreserveAlpha(boolean preserveAlpha)
Sets Alpha channel handling. A value of False indicates that the convolution should apply to the Alpha Channel

setSource

public void setSource(Filter src)
Sets the source to be Convolved

Parameters: src image to Convolved.

setTarget

public void setTarget(Point pt)
Sets the target point of the kernel (what pixel under the kernel should be set to the result of the convolution).
Copyright B) 2007 Apache Software Foundation. All Rights Reserved.