BiQuadVector3 Class Reference

BiQuad vector3 filter. More...

#include <math/gzmath.hh>

Inherits BiQuad< math::Vector3 >.

Public Member Functions

 BiQuadVector3 () GAZEBO_DEPRECATED(8.0)
 Constructor. More...
 
 BiQuadVector3 (double _fc, double _fs) GAZEBO_DEPRECATED(8.0)
 Constructor. More...
 
virtual const math::Vector3GetValue () GAZEBO_DEPRECATED(8.0)
 Get the output of the filter. More...
 
virtual const math::Vector3process (const math::Vector3 &_x)
 Update the filter's output. More...
 
void SetFc (double _fc, double _fs)
 Set the cutoff frequency and sample rate. More...
 
void SetFc (double _fc, double _fs, double _q)
 Set the cutoff frequency, sample rate and Q coefficient. More...
 
virtual void SetValue (const math::Vector3 &_val)
 Set the current filter's output. More...
 

Protected Attributes

double a0
 Input gain control coefficients. More...
 
double a1
 
double a2
 
double b0
 
double b1
 
double b2
 
math::Vector3 x1
 Gain of the feedback coefficients. More...
 
math::Vector3 x2
 
math::Vector3 y0
 Output. More...
 
math::Vector3 y1
 
math::Vector3 y2
 

Detailed Description

BiQuad vector3 filter.

Constructor & Destructor Documentation

BiQuadVector3 ( )
inline

Constructor.

References Filter< T >::SetValue().

BiQuadVector3 ( double  _fc,
double  _fs 
)
inline

Constructor.

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

References Filter< T >::SetValue().

Member Function Documentation

virtual const math::Vector3 & GetValue ( )
inlinevirtualinherited

Get the output of the filter.

Returns
Filter's output.

References Filter< T >::y0.

virtual const math::Vector3 & process ( const math::Vector3 _x)
inlinevirtualinherited

Update the filter's output.

Parameters
[in]_xInput value.
Returns
The filter's current output.

References Filter< T >::y0.

void SetFc ( double  _fc,
double  _fs 
)
inlinevirtualinherited

Set the cutoff frequency and sample rate.

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

Implements Filter< math::Vector3 >.

References Filter< T >::SetFc().

void SetFc ( double  _fc,
double  _fs,
double  _q 
)
inlineinherited

Set the cutoff frequency, sample rate and Q coefficient.

Parameters
[in]_fcCutoff frequency.
[in]_fsSample rate.
[in]_qQ coefficient.
virtual void SetValue ( const math::Vector3 _val)
inlinevirtualinherited

Set the current filter's output.

Parameters
[in]_valNew filter's output.

Reimplemented from Filter< math::Vector3 >.

References Filter< T >::y0.

Member Data Documentation

double a0
protectedinherited

Input gain control coefficients.

double a1
protectedinherited
double a2
protectedinherited
double b0
protectedinherited
double b1
protectedinherited
double b2
protectedinherited
math::Vector3 x1
protectedinherited

Gain of the feedback coefficients.

math::Vector3 x2
protectedinherited
math::Vector3 y0
protectedinherited

Output.

math::Vector3 y1
protectedinherited
math::Vector3 y2
protectedinherited

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