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

Filter base class. More...

#include <ignition/math/Filter.hh>

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

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

template<class T>

virtual ignition::math::Filter< T >::~Filter ( )

inlinevirtual

Destructor.

Member Function Documentation

template<class T>

virtual void ignition::math::Filter< T >::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 ignition::math::BiQuad< T >, ignition::math::BiQuad< math::Vector3d >, ignition::math::OnePole< T >, ignition::math::OnePole< math::Vector3d >, and ignition::math::OnePole< math::Quaterniond >.

template<class T>

virtual void ignition::math::Filter< T >::Set ( const T &  _val )

inlinevirtual

Set the output of the filter.

Parameters

[in]

_val

New value.

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

template<class T>

virtual const T& ignition::math::Filter< T >::Value ( ) const

inlinevirtual

Get the output of the filter.

Returns

Filter's output.

Member Data Documentation

template<class T>

T ignition::math::Filter< T >::y0 {}

protected

Output.

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

---

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

• Filter.hh