org.simbrain.world.visionworld.filter

Class RgbFilter

java.lang.Object

org.simbrain.world.visionworld.filter.RgbFilter

All Implemented Interfaces:

Filter

public class RgbFilter
extends java.lang.Object
implements Filter

Filters pixels against the provided thresholds and provides the fraction of those meeting the threshold against the provided lower and upper bound.

Threshold values may be positive and negative. Negative values are meaningful and represent an upper bound e.g. a red threshold of -100 would match against any pixel whose red value is less than 100. Positive thresholds are will match if the provided value is greater than or equal to the threshold.

Author:

Matt Watson

Constructor Summary

Constructors

Constructor and Description
RgbFilter(int red, int green, int blue) Creates a new filter.
RgbFilter(int red, int green, int blue, int lower, int upper) Creates a new filter.

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.
(package private) double	scale(int pixels, int total) Scales the percentage of bytes that meet the threshold to the provided upper and lower bound.

Methods inherited from class java.lang.Object

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

Constructor Detail

RgbFilter

public RgbFilter(int red,
                 int green,
                 int blue,
                 int lower,
                 int upper)

Creates a new filter.

Parameters:

red - The red threshold.

green - The green threshold.

blue - The blue threshold.

lower - The lower bound of the results.

upper - The upper bound of the results.

RgbFilter

public RgbFilter(int red,
                 int green,
                 int blue)

Creates a new filter.

Parameters:

red - The red threshold.

green - The green threshold.

blue - The blue threshold.

Method Detail

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

scale

double scale(int pixels,
             int total)

Scales the percentage of bytes that meet the threshold to the provided upper and lower bound.

Parameters:

pixels - The number of matching pixels.

total - The total number of pixels.

Returns:

The scaled value.

getDescription

public java.lang.String getDescription()

Return the description of this filter.

Specified by:

getDescription in interface Filter

Returns:

the description of this filter