All Classes Namespaces Files Functions Variables Typedefs Friends Macros Pages
Public Member Functions | List of all members
ignition::math::OnePoleQuaternion Class Reference

One-pole quaternion filter. More...

#include <ignition/math/Filter.hh>

Inheritance diagram for ignition::math::OnePoleQuaternion:
[legend]

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

Detailed Description

One-pole quaternion filter.

Constructor & Destructor Documentation

ignition::math::OnePoleQuaternion::OnePoleQuaternion ( )
inline
ignition::math::OnePoleQuaternion::OnePoleQuaternion ( double  _fc,
double  _fs 
)
inline

Constructor.

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

References ignition::math::Filter< math::Quaterniond >::Set().

Member Function Documentation

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

Update the filter's output.

[in] _x Input value.

Returns
The filter's current output.

References ignition::math::OnePole< math::Quaterniond >::a0, ignition::math::Quaternion< T >::Slerp(), and ignition::math::Filter< math::Quaterniond >::y0.


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