Ignition Math

API Reference

6.4.0
OnePoleQuaternion Class Reference

One-pole quaternion filter. More...

#include <ignition/math/Filter.hh>

Public Member Functions

 OnePoleQuaternion ()
 Constructor. More...
 
 OnePoleQuaternion (double _fc, double _fs)
 Constructor. More...
 
const math::QuaterniondProcess (const math::Quaterniond &_x)
 Update the filter's output. More...
 
- Public Member Functions inherited from OnePole< math::Quaterniond >
 OnePole ()=default
 Constructor. More...
 
 OnePole (double _fc, double _fs)
 Constructor. More...
 
virtual void Fc (double _fc, double _fs)
 Set the cutoff frequency and sample rate. More...
 
const math::QuaterniondProcess (const math::Quaterniond &_x)
 Update the filter's output. More...
 
- Public Member Functions inherited from Filter< math::Quaterniond >
virtual ~Filter ()
 Destructor. More...
 
virtual void Set (const math::Quaterniond &_val)
 Set the output of the filter. More...
 
virtual const math::QuaterniondValue () const
 Get the output of the filter. More...
 

Additional Inherited Members

- Protected Attributes inherited from OnePole< math::Quaterniond >
double a0
 Input gain control. More...
 
double b1
 Gain of the feedback. More...
 
- Protected Attributes inherited from Filter< math::Quaterniond >
math::Quaterniond y0
 Output. More...
 

Detailed Description

One-pole quaternion filter.

Constructor & Destructor Documentation

◆ OnePoleQuaternion() [1/2]

OnePoleQuaternion ( )
inline

Constructor.

References Filter< T >::Set().

◆ OnePoleQuaternion() [2/2]

OnePoleQuaternion ( double  _fc,
double  _fs 
)
inline

Constructor.

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

References Filter< T >::Set().

Member Function Documentation

◆ Process()

const math::Quaterniond& Process ( const math::Quaterniond _x)
inline

Update the filter's output.

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

References Quaternion< T >::Slerp(), and Filter< T >::y0.


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