ignition::math::OnePole< T > Class Template Reference

A one-pole DSP filter. More...

#include <ignition/math/Filter.hh>

Inheritance diagram for ignition::math::OnePole< T >:

Public Member Functions
	OnePole ()=default
	Constructor. More...
	OnePole (double _fc, double _fs)
	Constructor. More...
virtual void	Fc (double _fc, double _fs)
	Set the cutoff frequency and sample rate. More...
const T &	Process (const T &_x)
	Update the filter's output. More...
Public Member Functions inherited from ignition::math::Filter< T >
virtual	~Filter ()
	Destructor. More...
virtual void	Set (const T &_val)
	Set the output of the filter. More...
virtual const T &	Value () const
	Get the output of the filter. More...

Protected Attributes
double	a0 = 0
	Input gain control. More...
double	b1 = 0
	Gain of the feedback. More...
Protected Attributes inherited from ignition::math::Filter< T >
T	y0 {}
	Output. More...

Detailed Description

template<class T>
class ignition::math::OnePole< T >

A one-pole DSP filter.

See Also

http://www.earlevel.com/main/2012/12/15/a-one-pole-filter/

Constructor & Destructor Documentation

template<class T>

ignition::math::OnePole< T >::OnePole ( )

default

Constructor.

template<class T>

ignition::math::OnePole< T >::OnePole ( double  _fc, double  _fs  )

inline

Constructor.

Parameters

[in]	_fc	Cutoff frequency.
[in]	_fs	Sample rate.

Member Function Documentation

template<class T>

virtual void ignition::math::OnePole< T >::Fc ( double  _fc, double  _fs  )

inlinevirtual

Set the cutoff frequency and sample rate.

Parameters

[in]	_fc	Cutoff frequency.
[in]	_fs	Sample rate.

Implements ignition::math::Filter< T >.

Referenced by ignition::math::OnePole< math::Quaterniond >::OnePole().

template<class T>

const T& ignition::math::OnePole< T >::Process ( const T &  _x )

inline

Update the filter's output.

[in] _x Input value.

Returns

The filter's current output.

Member Data Documentation

template<class T>

double ignition::math::OnePole< T >::a0 = 0

protected

Input gain control.

Referenced by ignition::math::OnePole< math::Quaterniond >::Fc(), and ignition::math::OnePole< math::Quaterniond >::Process().

template<class T>

double ignition::math::OnePole< T >::b1 = 0

protected

Gain of the feedback.

Referenced by ignition::math::OnePole< math::Quaterniond >::Fc(), and ignition::math::OnePole< math::Quaterniond >::Process().

---

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

• Filter.hh