Package com.bc.ceres.jai

Class GeneralFilterFunction

java.lang.Object

com.bc.ceres.jai.GeneralFilterFunction

Direct Known Subclasses:

GeneralFilterFunction.Dilation, GeneralFilterFunction.Erosion, GeneralFilterFunction.Max, GeneralFilterFunction.Mean, GeneralFilterFunction.Median, GeneralFilterFunction.Min, GeneralFilterFunction.StdDev

public abstract class GeneralFilterFunction
extends Object

A general filter function. This class is used as parameter for the GeneralFilter operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeneralFilterFunction.Dilation
static class	GeneralFilterFunction.Erosion
static class	GeneralFilterFunction.Max
static class	GeneralFilterFunction.Mean
static class	GeneralFilterFunction.Median
static class	GeneralFilterFunction.Min
static class	GeneralFilterFunction.StdDev

Field Summary

Fields

Modifier and Type	Field	Description
protected int	height
protected boolean[]	structuringElement
protected int	width
protected int	xOrigin
protected int	yOrigin

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GeneralFilterFunction(int width, int height, int xOrigin, int yOrigin, boolean[] structuringElement)	Constructs a GeneralFilterFunction.

Method Summary

Modifier and Type	Method	Description
abstract float	filter(float[] fdata)
int	getBottomPadding()
int	getHeight()
int	getLeftPadding()
int	getRightPadding()
boolean[]	getStructuringElement()
int	getTopPadding()
int	getWidth()
int	getXOrigin()
int	getYOrigin()

Methods inherited from class java.lang.Object

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

Field Detail

width

protected final int width

height

protected final int height

xOrigin

protected final int xOrigin

yOrigin

protected final int yOrigin

structuringElement

protected final boolean[] structuringElement

Constructor Detail

GeneralFilterFunction

protected GeneralFilterFunction(int width,
                                int height,
                                int xOrigin,
                                int yOrigin,
                                boolean[] structuringElement)

Constructs a GeneralFilterFunction.

Parameters:

width - the width of the kernel.

height - the height of the kernel.

xOrigin - the X coordinate of the key kernel element.

yOrigin - the Y coordinate of the key kernel element.

structuringElement - The structuring element with a length equal to width * height. May be null.

Method Detail

getWidth

public final int getWidth()

Returns:

the width of the kernel.

getHeight

public final int getHeight()

Returns:

the height of the kernel.

getXOrigin

public final int getXOrigin()

Returns:

the X coordinate of the key kernel element.

getYOrigin

public final int getYOrigin()

Returns:

the Y coordinate of the key kernel element.

getLeftPadding

public final int getLeftPadding()

Returns:

the number of pixels required to the left of the key element.

getRightPadding

public final int getRightPadding()

Returns:

the number of pixels required to the right of the key element.

getTopPadding

public final int getTopPadding()

Returns:

the number of pixels required above the key element.

getBottomPadding

public final int getBottomPadding()

Returns:

the number of pixels required below the key element.

getStructuringElement

public boolean[] getStructuringElement()

filter

public abstract float filter(float[] fdata)