org.openimaj.image.processing.convolution

Class FGaussianConvolve

java.lang.Object

org.openimaj.image.processing.convolution.FGaussianConvolve

All Implemented Interfaces:

ImageProcessor<FImage>, Processor<FImage>, SinglebandImageProcessor<Float,FImage>

public class FGaussianConvolve
extends Object
implements SinglebandImageProcessor<Float,FImage>

Image processor for FImage capable of performing convolutions with Gaussians.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Nested Class Summary

Nested classes/interfaces inherited from interface org.openimaj.image.processor.SinglebandImageProcessor

SinglebandImageProcessor.Processable<T,S extends Image<T,S>,I extends Image<?,I>>

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_GAUSS_TRUNCATE The default number of sigmas at which the Gaussian function is truncated when building a kernel
protected float[]	kernel

Constructor Summary

Constructors

Constructor and Description
FGaussianConvolve(float sigma) Construct an FGaussianConvolve with a Gaussian of standard deviation sigma.
FGaussianConvolve(float sigma, float truncate) Construct an FGaussianConvolve with a Gaussian of standard deviation sigma.

Method Summary

Modifier and Type	Method and Description
static float[]	makeKernel(float sigma) Construct a zero-mean Gaussian with the specified standard deviation.
static float[]	makeKernel(float sigma, float truncate) Construct a zero-mean Gaussian with the specified standard deviation.
void	processImage(FImage image) Process an image.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GAUSS_TRUNCATE

public static final float DEFAULT_GAUSS_TRUNCATE

The default number of sigmas at which the Gaussian function is truncated when building a kernel

See Also:

Constant Field Values

kernel

protected float[] kernel

Constructor Detail

FGaussianConvolve

public FGaussianConvolve(float sigma)

Construct an FGaussianConvolve with a Gaussian of standard deviation sigma.

Parameters:

sigma - Gaussian kernel standard deviation

FGaussianConvolve

public FGaussianConvolve(float sigma,
                         float truncate)

Construct an FGaussianConvolve with a Gaussian of standard deviation sigma. The truncate parameter defines how many sigmas wide the kernel is.

Parameters:

sigma -

truncate -

Method Detail

makeKernel

public static float[] makeKernel(float sigma)

Construct a zero-mean Gaussian with the specified standard deviation.

Parameters:

sigma - the standard deviation of the Gaussian

Returns:

an array representing a Gaussian function

makeKernel

public static float[] makeKernel(float sigma,
                                 float truncate)

Construct a zero-mean Gaussian with the specified standard deviation.

Parameters:

sigma - the standard deviation of the Gaussian

truncate - the number of sigmas from the centre at which to truncate the Gaussian

Returns:

an array representing a Gaussian function

processImage

public void processImage(FImage image)

Description copied from interface: ImageProcessor

Process an image. Implementing classes must alter the image passed in-place or assign the output to the input using Image.internalAssign(Image).

Specified by:

processImage in interface ImageProcessor<FImage>

Parameters:

image - The image to process in place.