Filter< T > Class Template Reference

Filter base class. More...

#include <ignition/math/Filter.hh>

Public Member Functions
virtual	~Filter ()
	Destructor. More...
virtual void	Fc (double _fc, double _fs)=0
	Set the cutoff frequency and sample rate. 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
T	y0 {}
	Output. More...

Detailed Description

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

Filter base class.

Constructor & Destructor Documentation

~Filter()

virtual ~Filter ( )

inlinevirtual

Destructor.

Member Function Documentation

Fc()

virtual void Fc ( double  _fc, double  _fs  )

pure virtual

Set the cutoff frequency and sample rate.

Parameters

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

Implemented in BiQuad< T >, BiQuad< math::Vector3d >, OnePole< T >, OnePole< math::Vector3d >, and OnePole< math::Quaterniond >.

Set()

virtual void Set ( const T &  _val )

inlinevirtual

Set the output of the filter.

Parameters

[in]

_val

New value.

Reimplemented in BiQuad< T >, and BiQuad< math::Vector3d >.

Value()

virtual const T& Value ( ) const

inlinevirtual

Get the output of the filter.

Returns

Filter's output.

Member Data Documentation

y0

T y0 {}

protected

Output.

Referenced by OnePole< math::Quaterniond >::Process(), BiQuad< math::Vector3d >::Process(), Filter< math::Quaterniond >::Set(), BiQuad< math::Vector3d >::Set(), and Filter< math::Quaterniond >::Value().

---

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

• gz/math/Filter.hh