Ignition Math

API Reference

6.8.0
Filter< T > Class Template Referenceabstract

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

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()

virtual void Set ( const T &  _val)
inlinevirtual

Set the output of the filter.

Parameters
[in]_valNew value.

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

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

◆ Value()

virtual const T& Value ( ) const
inlinevirtual

Get the output of the filter.

Returns
Filter's output.

Member Data Documentation

◆ y0


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