org.simbrain.world.visionworld.filter

Class RandomFilter

java.lang.Object

org.simbrain.world.visionworld.filter.RandomFilter

All Implemented Interfaces:

Filter

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

Random filter.

Constructor Summary

Constructors

Constructor and Description
RandomFilter(double minimumValue, double maximumValue) Create a new random filter with the specified minimum and maximum values.

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	getMaximumValue() Return the maximum value for this random filter.
double	getMinimumValue() Return the minimum value for this random filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomFilter

public RandomFilter(double minimumValue,
                    double maximumValue)

Create a new random filter with the specified minimum and maximum values.

Parameters:

minimumValue - minimum value for this random filter

maximumValue - maximum value for this random filter

Throws:

java.lang.IllegalArgumentException - if minimumValue is greater than maximumValue

Method Detail

getMinimumValue

public double getMinimumValue()

Return the minimum value for this random filter.

Returns:

the minimum value for this random filter

getMaximumValue

public double getMaximumValue()

Return the maximum value for this random filter.

Returns:

the maximum value for this random 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