okapi::AverageFilter< n > Class Template Reference

A filter which returns the average of a list of values. More...

#include <averageFilter.hpp>

Inheritance diagram for okapi::AverageFilter< n >:

Public Member Functions
	AverageFilter ()=default
	Averaging filter.
double	filter (const double ireading) override
	Filters a value, like a sensor reading.
double	getOutput () const override
	Returns the previous output from filter.
Public Member Functions inherited from okapi::Filter
virtual	~Filter ()

Protected Attributes
std::array< double, n >	data {0}
std::size_t	index = 0
double	output = 0

Detailed Description

template<std::size_t n>
class okapi::AverageFilter< n >

A filter which returns the average of a list of values.

Template Parameters

n	number of taps in the filter

Definition at line 18 of file averageFilter.hpp.

Constructor & Destructor Documentation

AverageFilter()

template<std::size_t n>

okapi::AverageFilter< n >::AverageFilter ( )

default

Averaging filter.

Member Function Documentation

filter()

template<std::size_t n>

double okapi::AverageFilter< n >::filter ( const double  ireading )

inlineoverridevirtual

Filters a value, like a sensor reading.

Parameters

ireading

new measurement

Returns

filtered result

Implements okapi::Filter.

Definition at line 31 of file averageFilter.hpp.

getOutput()

template<std::size_t n>

double okapi::AverageFilter< n >::getOutput ( ) const

inlineoverridevirtual

Returns the previous output from filter.

Returns

the previous output from filter

Implements okapi::Filter.

Definition at line 50 of file averageFilter.hpp.

Member Data Documentation

data

template<std::size_t n>

std::array<double, n> okapi::AverageFilter< n >::data {0}

protected

Definition at line 55 of file averageFilter.hpp.

index

template<std::size_t n>

std::size_t okapi::AverageFilter< n >::index = 0

protected

Definition at line 56 of file averageFilter.hpp.

output

template<std::size_t n>

double okapi::AverageFilter< n >::output = 0

protected

Definition at line 57 of file averageFilter.hpp.

---

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

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