IdleState Class Reference

Filter for removing vectors based on their magnitude. More...

Inheritance diagram for IdleState:

[legend]

Collaboration diagram for IdleState:

[legend]

List of all members.

Public Member Functions
	IdleState ()
	Creates the Filter with a default threshold of 1.2.
Accel3D	filter (Accel3D acc)
	Takes in a sample and returns either the unchanged sample or null depending on the Filter's criteria.
String	getDefaults ()
	Returns the default parameter String for this Filter.
String	getName ()
	Returns the name of this Filter.
String	getParameters ()
	Returns the current parameters in a comma-separated String of values.
void	setup (String args)
	Takes only one value, a threshold.

---

Detailed Description

Filter for removing vectors based on their magnitude.

If a vector has a magnitude less than the threshold, it is discarded.

Author:

Team Better Recognize

---

Constructor & Destructor Documentation

IdleState

(

)

Creates the Filter with a default threshold of 1.2.

---

Member Function Documentation

Accel3D filter

(

Accel3D

acc

)

Takes in a sample and returns either the unchanged sample or null depending on the Filter's criteria.

Parameters:

acc

data to be filtered out

Returns:

null if the filter removed this Accel3D. Otherwise returns the original Accel3D unmodified.

Implements Filter.

Here is the call graph for this function:

String getDefaults

(

)

Returns the default parameter String for this Filter.

Returns:

the default parameter String that will be used in setup if a blank is given

Implements Filter.

Here is the caller graph for this function:

String getName

(

)

Returns the name of this Filter.

Returns:

the name of this Filter

Implements Filter.

String getParameters

(

)

Returns the current parameters in a comma-separated String of values.

The values are returned in exactly the same order and style that they would be passed in through the setup(String) method.

Returns:

the current parameter String for this Filter

Implements Filter.

void setup

(

String

args

)

Takes only one value, a threshold.

Example parameter Strings:

• "1.2" (default)
• "0.3"
• "0.0" (accept all vectors/discard nothing)

Implements Filter.

Here is the call graph for this function:

---

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

• /Users/dev/Documents/SVN brazos.cs.tcu.edu/trunk/FROG/src/frog/IdleState.java