Filter Interface Reference

Common interface for all Filters. More...

Inheritance diagram for Filter:

[legend]

List of all members.

Public Member Functions
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.
Static Package Attributes
static final int	X = 0
static final int	Y = 1
static final int	Z = 2

---

Detailed Description

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

---

Member Function Documentation

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.

void setup

(

String

args

)

Sets up this Filter with a given parameter String.

Parameters:

args

a comma-separated list of values.

Implemented in DirectorialEquivalenceFilter, and IdleStateFilter.

Here is the caller graph for this function:

---

Member Data Documentation

final int X = 0 [static, package]

final int Y = 1 [static, package]

final int Z = 2 [static, package]

---

The documentation for this interface was generated from the following file:

• /Users/dev/Documents/SVN brazos.cs.tcu.edu/trunk/FROG SPOT/src/frog/plugin/spot/onspot/Filter.java