Filter< T > Class Template Reference

Filter base class. More...

#include <gz/math/Filter.hh>

Public Member Functions
virtual	~Filter ()
	Destructor.
virtual void	Fc (double _fc, double _fs)=0
	Set the cutoff frequency and sample rate.
virtual void	Set (const T &_val)
	Set the output of the filter.
virtual const T &	Value () const
	Get the output of the filter.

Protected Attributes
T	y0 {}
	Output.

Detailed Description

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

Filter base class.

Constructor & Destructor Documentation

~Filter()

template<class T >

virtual ~Filter ( )

inlinevirtual

Destructor.

Member Function Documentation

Fc()

template<class T >

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

Set()

template<class T >

virtual void Set ( const T &  _val )

inlinevirtual

Set the output of the filter.

Parameters

[in]

_val

New value.

Reimplemented in BiQuad< T >.

References Filter< T >::y0.

Referenced by OnePoleQuaternion::OnePoleQuaternion(), OnePoleQuaternion::OnePoleQuaternion(), OnePoleVector3::OnePoleVector3(), and OnePoleVector3::OnePoleVector3().

Value()

template<class T >

virtual const T & Value ( ) const

inlinevirtual

Get the output of the filter.

Returns

Filter's output.

References Filter< T >::y0.

Member Data Documentation

y0

template<class T >

T y0 {}

protected

Output.

Referenced by OnePoleQuaternion::Process(), OnePole< T >::Process(), BiQuad< T >::Process(), Filter< T >::Set(), BiQuad< T >::Set(), and Filter< T >::Value().

---

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

• Filter.hh