RML  1.0
Robotics Mathematical Library
Loading...
Searching...
No Matches
futils::FirstOrderFilter Struct Reference

#include <Futils.h>

Public Member Functions

 FirstOrderFilter ()
 
void Reset ()
 
void Init (const int dataSize, const double alpha)
 
std::vector< double > & Filter (const std::vector< double > array)
 

Public Attributes

std::vector< double > prevState_
 
std::vector< double > filteredData_
 
bool isRunning_
 
bool initialised_
 
int dataSize_
 
double alpha_
 

Detailed Description

This function performs a simple 1D filtering over an array of data. The result is the output of the following function: y(i) = alpha * x(i) + ( 1 - alpha ) * y(i-1)

alpha is the 'b' output parameter of the 'ellip' MATLAB function: [b, a] = ellip(filterOrder, passbandRipple, stopbandAtt, radPerSample)

Parameters
array
size
alpha
Returns

Constructor & Destructor Documentation

◆ FirstOrderFilter()

futils::FirstOrderFilter::FirstOrderFilter ( )
inline

Member Function Documentation

◆ Filter()

std::vector< double > & futils::FirstOrderFilter::Filter ( const std::vector< double >  array)
inline

◆ Init()

void futils::FirstOrderFilter::Init ( const int  dataSize,
const double  alpha 
)
inline

◆ Reset()

void futils::FirstOrderFilter::Reset ( )
inline

Member Data Documentation

◆ alpha_

double futils::FirstOrderFilter::alpha_

◆ dataSize_

int futils::FirstOrderFilter::dataSize_

◆ filteredData_

std::vector<double> futils::FirstOrderFilter::filteredData_

◆ initialised_

bool futils::FirstOrderFilter::initialised_

◆ isRunning_

bool futils::FirstOrderFilter::isRunning_

◆ prevState_

std::vector<double> futils::FirstOrderFilter::prevState_

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