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

Filter base class. More...

#include <ignition/math/Filter.hh>

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

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 ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Filter< T >

Filter base class.

Constructor & Destructor Documentation

~Filter()

template<class T>

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

inlinevirtual

Destructor.

Member Function Documentation

Fc()

template<class T>

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

Set()

template<class T>

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

inlinevirtual

Set the output of the filter.

Parameters

[in]

_val

New value.

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

References y0.

Value()

template<class T>

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

inlinevirtual

Get the output of the filter.

Returns

Filter's output.

References y0.

Member Data Documentation

y0

template<class T>

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

protected

Output.

Referenced by ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::Process(), ignition::math::IGNITION_MATH_VERSION_NAMESPACE::OnePole< T >::Process(), ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::Set(), Set(), and Value().

---

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

• Filter.hh