OnePole< T > Class Template Reference

A one-pole DSP filter. More...

#include <math/gzmath.hh>

Inherits Filter< T >.

Public Member Functions

 OnePole () GAZEBO_DEPRECATED(8.0)
 Constructor. More...
 
 OnePole (double _fc, double _fs) GAZEBO_DEPRECATED(8.0)
 Constructor. More...
 
virtual const T & GetValue () GAZEBO_DEPRECATED(8.0)
 Get the output of the filter. More...
 
const T & Process (const T &_x)
 Update the filter's output. More...
 
virtual void SetFc (double _fc, double _fs)
 Set the cutoff frequency and sample rate. More...
 
virtual void SetValue (const T &_val) GAZEBO_DEPRECATED(8.0)
 Set the output of the filter. More...
 

Protected Attributes

double a0
 Input gain control. More...
 
double b1
 Gain of the feedback. More...
 
y0
 Output. More...
 

Detailed Description

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

A one-pole DSP filter.

See also
http://www.earlevel.com/main/2012/12/15/a-one-pole-filter/

Constructor & Destructor Documentation

OnePole ( )
inline

Constructor.

Deprecated:
See ignition::math::OnePole
OnePole ( double  _fc,
double  _fs 
)
inline

Constructor.

Parameters
[in]_fcCutoff frequency.
[in]_fsSample rate.
Deprecated:
See ignition::math::OnePole

Member Function Documentation

virtual const T& GetValue ( )
inlinevirtualinherited

Get the output of the filter.

Returns
Filter's output.
const T& Process ( const T &  _x)
inline

Update the filter's output.

[in] _x Input value.

Returns
The filter's current output.
virtual void SetFc ( double  _fc,
double  _fs 
)
inlinevirtual

Set the cutoff frequency and sample rate.

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

Implements Filter< T >.

virtual void SetValue ( const T &  _val)
inlinevirtualinherited

Set the output of the filter.

Parameters
[in]_valNew value.

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

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

Member Data Documentation

double a0
protected

Input gain control.

double b1
protected

Gain of the feedback.


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