Filter< T > Class Template Reference

Filter base class. More...

#include <math/gzmath.hh>

Inherited by BiQuad< T >, and OnePole< T >.

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

Protected Attributes
T	y0
	Output. More...

Detailed Description

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

Filter base class.

Constructor & Destructor Documentation

~Filter()

virtual ~Filter ( )

inlinevirtual

Destructor.

Member Function Documentation

GetValue()

virtual const T& GetValue ( )

inlinevirtual

Get the output of the filter.

Returns

Filter's output.

SetFc()

virtual void SetFc ( 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::Vector3 >, OnePole< T >, OnePole< float >, OnePole< math::Quaternion >, and OnePole< math::Vector3 >.

Referenced by BiQuad< math::Vector3 >::BiQuad(), OnePole< math::Vector3 >::OnePole(), BiQuad< math::Vector3 >::SetFc(), and Filter< math::Vector3 >::SetValue().

SetValue()

virtual void SetValue ( const T &  _val )

inlinevirtual

Set the output of the filter.

Parameters

[in]

_val

New value.

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

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

Member Data Documentation

y0

T y0

protected

Output.

Referenced by Filter< math::Vector3 >::GetValue(), OnePole< math::Vector3 >::Process(), OnePoleQuaternion::Process(), BiQuad< math::Vector3 >::process(), Filter< math::Vector3 >::SetValue(), and BiQuad< math::Vector3 >::SetValue().

---

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

• Filter.hh