Documentation
Tools for embedded systems
Loading...
Searching...
No Matches
qlibs::smootherEXPW Class Reference

An Exponential weighting filter. More...

#include <smoother.hpp>

Inheritance diagram for qlibs::smootherEXPW:
qlibs::smoother qlibs::rms

Public Member Functions

virtual ~smootherEXPW ()
 
bool setup (const real_t lam=0.8_re)
 Setup an initialize the Exponential weighting filter.
 
real_t smooth (const real_t x) override
 Perform the smooth operation recursively for the input signal x.
 
- Public Member Functions inherited from qlibs::smoother
virtual ~smoother ()
 
bool isInitialized (void) const
 Check if the smoother filter is initialized.
 
bool reset (void)
 Reset the the smoother filter.
 

Detailed Description

An Exponential weighting filter.

Constructor & Destructor Documentation

◆ ~smootherEXPW()

virtual qlibs::smootherEXPW::~smootherEXPW ( )
inlinevirtual

Member Function Documentation

◆ setup()

bool smootherEXPW::setup ( const real_t lam = 0.8_re)

Setup an initialize the Exponential weighting filter.

Parameters
[in]lamForgetting factor, a value between [ 0 < lam < 1 ]
Returns
true on success, otherwise return false.

◆ smooth()

real_t smootherEXPW::smooth ( const real_t x)
overridevirtual

Perform the smooth operation recursively for the input signal x.

Precondition
Instance must be previously initialized
Parameters
[in]xA sample of the input signal.
Returns
The smoothed output.

Implements qlibs::smoother.