StatisticalFilter Class Reference
[Filters]

#include <StatisticalFilter.h>

Inheritance diagram for StatisticalFilter:

Collaboration diagram for StatisticalFilter:

Detailed Description

returns basic statistics about series of values updated.

Can return percentiles or values, the standard deviation, and the average of the values.

Definition at line 54 of file StatisticalFilter.h.


Public Member Functions
	StatisticalFilter (int history=1)
	Construct a new filter, and pass whether to keep history (to support percentiles).
void	update (double incoming)
	To add a new value to the filter, you call update. What the filter does is up to the kind of filter it is.
double	getDeviation () const
	return the standard deviation
int	getCount () const
	return the number of samples
double	percentileToValue (double percentile) const
	return the value for a given percentile
double	valueToPercentile (double value) const
	return the percentile for a given value
double	getMin () const
	return the minimum value (or getPercentile(0.0))
double	getMax () const
	return the maximum value (or getPrecentile(1.0))
int	reset ()
	reset the filter to 0

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