okapi::EmaFilter Class Reference

#include <emaFilter.hpp>

Inheritance diagram for okapi::EmaFilter:

Public Member Functions
	EmaFilter (double ialpha)
	Exponential moving average filter.
double	filter (double ireading) override
	Filters a value, like a sensor reading.
double	getOutput () const override
	Returns the previous output from filter.
virtual void	setGains (double ialpha)
	Set filter gains.
Public Member Functions inherited from okapi::Filter
virtual	~Filter ()

Protected Attributes
double	alpha
double	output = 0
double	lastOutput = 0

Detailed Description

Definition at line 11 of file emaFilter.hpp.

Constructor & Destructor Documentation

EmaFilter()

okapi::EmaFilter::EmaFilter ( double  ialpha )

explicit

Exponential moving average filter.

Parameters

ialpha

alpha gain

Member Function Documentation

filter()

double okapi::EmaFilter::filter ( double  ireading )

overridevirtual

Filters a value, like a sensor reading.

Parameters

reading

new measurement

Returns

filtered result

Implements okapi::Filter.

getOutput()

double okapi::EmaFilter::getOutput ( ) const

overridevirtual

Returns the previous output from filter.

Returns

the previous output from filter

Implements okapi::Filter.

setGains()

virtual void okapi::EmaFilter::setGains ( double  ialpha )

virtual

Set filter gains.

Parameters

ialpha

alpha gain

Member Data Documentation

alpha

double okapi::EmaFilter::alpha

protected

Definition at line 43 of file emaFilter.hpp.

lastOutput

double okapi::EmaFilter::lastOutput = 0

protected

Definition at line 45 of file emaFilter.hpp.

output

double okapi::EmaFilter::output = 0

protected

Definition at line 44 of file emaFilter.hpp.

---

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

• include/okapi/api/filter/emaFilter.hpp