frog.plugin.spot.onspot
Interface Filter

All Known Implementing Classes:
DirectorialEquivalenceFilter, IdleStateFilter

public interface Filter

Common interface for all Filters. Allows FilterManager to pass the argument String and samples into them.

WARNING! Do not attempt to create a constructor that requires parameters or make the constructor private! FilterManager must be able to call Class.newInstance() on your Filter to instantiate it!

Author:
Team Better Recognize

Field Summary
static int X
           
static int Y
           
static int Z
           
 
Method Summary
 double[] filter(double[] sample)
          Takes in a sample and returns either the unchanged sample or null depending on the Filter's criteria.
 void setup(String args)
          Sets up this Filter with a given parameter String
 

Field Detail

X

static final int X
See Also:
Constant Field Values

Y

static final int Y
See Also:
Constant Field Values

Z

static final int Z
See Also:
Constant Field Values
Method Detail

filter

double[] filter(double[] sample)
Takes in a sample and returns either the unchanged sample or null depending on the Filter's criteria.

Parameters:
sample - data to be filtered out
Returns:
null if the filter removed this sample. Otherwise returns the original sample unmodified.

setup

void setup(String args)
Sets up this Filter with a given parameter String

Parameters:
args - a comma-separated list of values.