Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T > Class Template Reference

Bi-quad filter base class. More...

#include <ignition/math/Filter.hh>

Inheritance diagram for ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >:
[legend]

Public Member Functions

 BiQuad ()=default
 Constructor.
 
 BiQuad (double _fc, double _fs)
 Constructor.
 
void Fc (double _fc, double _fs)
 Set the cutoff frequency and sample rate.
 
void Fc (double _fc, double _fs, double _q)
 Set the cutoff frequency, sample rate and Q coefficient.
 
virtual const T & Process (const T &_x)
 Update the filter's output.
 
virtual void Set (const T &_val)
 Set the current filter's output.
 
- Public Member Functions inherited from ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Filter< T >
virtual ~Filter ()
 Destructor.
 
virtual const T & Value () const
 Get the output of the filter.
 

Protected Attributes

double a0 = 0
 Input gain control coefficients.
 
double a1 = 0
 
double a2 = 0
 
double b0 = 0
 
double b1 = 0
 
double b2 = 0
 
x1 {}
 Gain of the feedback coefficients.
 
x2 {}
 
y1 {}
 
y2 {}
 
- Protected Attributes inherited from ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Filter< T >
y0 {}
 Output.
 

Detailed Description

template<class T>
class ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >

Bi-quad filter base class.

See also
http://www.earlevel.com/main/2003/03/02/the-bilinear-z-transform/

Constructor & Destructor Documentation

◆ BiQuad() [1/2]

template<class T >
ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::BiQuad ( )
default

Constructor.

◆ BiQuad() [2/2]

template<class T >
ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::BiQuad ( double _fc,
double _fs )
inline

Constructor.

Parameters
[in]_fcCutoff frequency.
[in]_fsSample rate.

References ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::Fc().

Member Function Documentation

◆ Fc() [1/2]

template<class T >
void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::Fc ( double _fc,
double _fs )
inlinevirtual

◆ Fc() [2/2]

template<class T >
void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::Fc ( double _fc,
double _fs,
double _q )
inline

◆ Process()

template<class T >
virtual const T & ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::Process ( const T & _x)
inlinevirtual

◆ Set()

template<class T >
virtual void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::Set ( const T & _val)
inlinevirtual

Member Data Documentation

◆ a0

template<class T >
double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::a0 = 0
protected

◆ a1

template<class T >
double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::a1 = 0
protected

◆ a2

template<class T >
double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::a2 = 0
protected

◆ b0

template<class T >
double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::b0 = 0
protected

◆ b1

template<class T >
double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::b1 = 0
protected

◆ b2

template<class T >
double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::b2 = 0
protected

◆ x1

template<class T >
T ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::x1 {}
protected

◆ x2

template<class T >
T ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::x2 {}
protected

◆ y1

template<class T >
T ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::y1 {}
protected

◆ y2

template<class T >
T ignition::math::IGNITION_MATH_VERSION_NAMESPACE::BiQuad< T >::y2 {}
protected

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