imagingbook.lib.filters

Class GenericFilter

java.lang.Object

imagingbook.lib.filters.GenericFilter

Direct Known Subclasses:

BilateralFilter, KuwaharaFilter, LinearFilter, NagaoMatsuyamaFilter, ScalarMedianFilter, VectorMedianFilter, VectorMedianFilterSharpen

public abstract class GenericFilter
extends Object

This abstract class represents a generic filter that, when applied to an ImageProcessor object performs all pixel-level iterations automatically. Concrete implementations of this class need to define only two methods:
float filterPixel(ImageAccessor.Scalar, int, int) and
float[] filterPixel(ImageAccessor.Rgb, int, int).
See LinearFilter for a sample implementation.
Note that this is experimental code!

Version:

2016/11/01

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericFilter()

Method Summary

Modifier and Type	Method and Description
void	applyTo(ij.process.ImageProcessor ip) Dispatch work depending on actual (runtime) type of processor.
abstract float[]	filterPixel(ImageAccessor.Rgb source, int u, int v) Calculates and returns the filter result for a single pixel at the given position.
abstract float	filterPixel(ImageAccessor.Scalar source, int u, int v) Calculates and returns the filter result for a single pixel at the given position.
void	setOutOfBoundsStrategy(OutOfBoundsStrategy obs) Set the out-of-bounds strategy of this GenericFilter.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericFilter

protected GenericFilter()

Method Detail

setOutOfBoundsStrategy

public void setOutOfBoundsStrategy(OutOfBoundsStrategy obs)

Set the out-of-bounds strategy of this GenericFilter. See OutOfBoundsStrategy.

Parameters:

obs - the out-of-bounds strategy

filterPixel

public abstract float filterPixel(ImageAccessor.Scalar source,
                                  int u,
                                  int v)

Calculates and returns the filter result for a single pixel at the given position.

Parameters:

source - the ImageAccessor.Scalar representing the source (scalar-valued) image

u - the horizontal pixel position

v - the vertical pixel position

Returns:

the resulting (scalar) filter value for the specified pixel position

filterPixel

public abstract float[] filterPixel(ImageAccessor.Rgb source,
                                    int u,
                                    int v)

Calculates and returns the filter result for a single pixel at the given position.

Parameters:

source - the ImageAccessor.Rgb representing the source (RGB) image

u - the horizontal pixel position

v - the vertical pixel position

Returns:

the resulting (RGB) filter value for the specified pixel position

applyTo

public void applyTo(ij.process.ImageProcessor ip)

Dispatch work depending on actual (runtime) type of processor. This is ugly but we want to avoid generic types (which would not be of much help in this case anyway).

Parameters:

ip - the image this filter is applied to (destructively)