org.simbrain.world.visionworld.filter

Class UniformFilter

java.lang.Object

org.simbrain.world.visionworld.filter.UniformFilter

All Implemented Interfaces:

Filter

public final class UniformFilter
extends java.lang.Object
implements Filter

Uniform filter.

Constructor Summary

Constructors

Constructor and Description
UniformFilter(double value) Create a new uniform filter with the specified value.

Method Summary

Modifier and Type	Method and Description
double	filter(java.awt.image.BufferedImage image) Reduce the specified image to a single value.
java.lang.String	getDescription() Return the description of this filter.
double	getValue() Return the value for this uniform filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniformFilter

public UniformFilter(double value)

Create a new uniform filter with the specified value.

Parameters:

value - value for this uniform filter

Method Detail

getValue

public double getValue()

Return the value for this uniform filter.

Returns:

the value for this uniform filter

filter

public double filter(java.awt.image.BufferedImage image)

Reduce the specified image to a single value.

Specified by:

filter in interface Filter

Parameters:

image - image, must not be null

Returns:

value for the specified image

getDescription

public java.lang.String getDescription()

Description copied from interface: Filter

Return the description of this filter.

Specified by:

getDescription in interface Filter

Returns:

the description of this filter