org.openimaj.image.processing.convolution

Class AverageBoxFilter

java.lang.Object

org.openimaj.image.processing.convolution.AverageBoxFilter

All Implemented Interfaces:

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

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

A rectangular averaging convolution operator (often known as a Box filter). For efficiency, this is implemented using a SummedAreaTable rather than through an actual convolution.

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>>

Constructor Summary

Constructors

Constructor and Description
AverageBoxFilter(int dim) Construct the averaging operator with a square kernel of the given dimension.
AverageBoxFilter(int width, int height) Construct the averaging operator with a kernel of the given dimensions.

Method Summary

Modifier and Type	Method and Description
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

Constructor Detail

AverageBoxFilter

public AverageBoxFilter(int width,
                        int height)

Construct the averaging operator with a kernel of the given dimensions.

Parameters:

width - width of the kernel

height - height of the kernel

AverageBoxFilter

public AverageBoxFilter(int dim)

Construct the averaging operator with a square kernel of the given dimension.

Parameters:

dim - The width and height of the box

Method Detail

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.