qlibs::smootherLPF1 Class Reference

A 1st order Low-Pass Filter. More...

#include <smoother.hpp>

Inheritance diagram for qlibs::smootherLPF1:

Public Member Functions
virtual	~smootherLPF1 ()
bool	setup (const real_t a=0.9_re)
	Setup an initialize the 1st order Low-Pass 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 has been initialized using setup().
	operator bool () const noexcept
	Check if the smoother filter has been initialized using setup().
bool	reset (void)
	Reset the smoother filter.

Detailed Description

A 1st order Low-Pass Filter.

Constructor & Destructor Documentation

~smootherLPF1()

virtual qlibs::smootherLPF1::~smootherLPF1 ( )

inlinevirtual

Member Function Documentation

setup()

bool smootherLPF1::setup

(

const real_t

a = 0.9_re

)

Setup an initialize the 1st order Low-Pass Filter.

Parameters

[in]

a

The filter adjustment parameter. A value between [ 0 < alpha < 1 ]

Returns

true on success, otherwise return false.

smooth()

real_t smootherLPF1::smooth ( const real_t x )

overridevirtual

Perform the smooth operation recursively for the input signal x.

Precondition

Instance must be previously initialized

Parameters

[in]

x

A sample of the input signal.

Returns

The smoothed output.

Implements qlibs::smoother.