Documentation
Tools for embedded systems
Loading...
Searching...
No Matches
qlibs::smoother Class Referenceabstract

The smoother base abstract class. More...

#include <smoother.hpp>

Inheritance diagram for qlibs::smoother:
qlibs::smootherALNF qlibs::smootherDESF qlibs::smootherEXPW qlibs::smootherGMWF qlibs::smootherKLMN qlibs::smootherLPF1 qlibs::smootherLPF2 qlibs::smootherMOR1 qlibs::smootherMOR2 qlibs::smootherMWM1 qlibs::smootherMWM2

Public Member Functions

virtual ~smoother ()
 
bool isInitialized (void) const
 Check if the smoother filter is initialized.
 
virtual real_t smooth (const real_t x)=0
 Perform the smooth operation recursively for the input signal x.
 
bool reset (void)
 Reset the the smoother filter.
 

Detailed Description

The smoother base abstract class.

Constructor & Destructor Documentation

◆ ~smoother()

virtual qlibs::smoother::~smoother ( )
inlinevirtual

Member Function Documentation

◆ isInitialized()

bool qlibs::smoother::isInitialized ( void ) const

Check if the smoother filter is initialized.

Returns
true if the smoother has been initialized, otherwise return false.

◆ reset()

bool qlibs::smoother::reset ( void )
inline

Reset the the smoother filter.

Returns
true on success, otherwise return false.

◆ smooth()

virtual real_t qlibs::smoother::smooth ( const real_t x)
pure virtual

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.

Implemented in qlibs::smootherALNF, qlibs::smootherDESF, qlibs::smootherEXPW, qlibs::smootherGMWF, qlibs::smootherKLMN, qlibs::smootherLPF1, qlibs::smootherLPF2, qlibs::smootherMOR1, qlibs::smootherMOR2, qlibs::smootherMWM1, and qlibs::smootherMWM2.