alvar::FilterRunningAverage Class Reference

FilterRunningAverage provides an weighted running average filter More...

#include <Filter.h>

Inheritance diagram for alvar::FilterRunningAverage:

List of all members.

Public Member Functions
	FilterRunningAverage (double _alpha=0.5)
double	getAlpha ()
virtual double	next (double y)
	Update the value. All inherited classes need to update value in next().
double	operator= (double _value)
virtual void	reset ()
	Reset the filter state.
void	setAlpha (double _alpha)
Protected Attributes
double	alpha
bool	breset

---

Detailed Description

FilterRunningAverage provides an weighted running average filter

Note:

This could be named also as FilterSingleExponentialSmoothing

The FilterRunningAverage calculates a simple running average using the weight value alpha.

                value = ((1.0-alpha) * value) + (alpha * (double)y);

If alpha is larger (near 1.0) the average reacts faster for changes and if it is near 0.0 then it reacts slowly. The weight value alpha may be set in the constructor or with setAlpha() .

Examples:

SampleFilter.cpp.

Definition at line 159 of file Filter.h.

---

Constructor & Destructor Documentation

alvar::FilterRunningAverage::FilterRunningAverage

(

double

_alpha = 0.5

)

[inline]

Definition at line 164 of file Filter.h.

---

Member Function Documentation

double alvar::FilterRunningAverage::getAlpha

(

)

[inline]

Definition at line 166 of file Filter.h.

double alvar::FilterRunningAverage::next

(

double

y

)

[virtual]

Update the value. All inherited classes need to update value in next().

Implements alvar::Filter.

Reimplemented in alvar::FilterDoubleExponentialSmoothing.

Definition at line 87 of file Filter.cpp.

double alvar::FilterRunningAverage::operator=

(

double

_value

)

[inline]

Reimplemented in alvar::FilterDoubleExponentialSmoothing.

Definition at line 167 of file Filter.h.

void alvar::FilterRunningAverage::reset

(

)

[virtual]

Reset the filter state.

Implements alvar::Filter.

Definition at line 97 of file Filter.cpp.

void alvar::FilterRunningAverage::setAlpha

(

double

_alpha

)

[inline]

Definition at line 165 of file Filter.h.

---

Member Data Documentation

double alvar::FilterRunningAverage::alpha [protected]

Definition at line 161 of file Filter.h.

bool alvar::FilterRunningAverage::breset [protected]

Definition at line 162 of file Filter.h.

---

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

• Filter.h
• Filter.cpp