ignition::math::IGNITION_MATH_VERSION_NAMESPACE::OnePoleQuaternion Class Reference

One-pole quaternion filter. More...

#include <ignition/math/Filter.hh>

Inheritance diagram for ignition::math::IGNITION_MATH_VERSION_NAMESPACE::OnePoleQuaternion:

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

Additional Inherited Members
Protected Attributes inherited from ignition::math::IGNITION_MATH_VERSION_NAMESPACE::OnePole< math::Quaterniond >
double	a0
	Input gain control.
double	a0
	Input gain control.
double	b1
	Gain of the feedback.
double	b1
	Gain of the feedback.
Protected Attributes inherited from ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Filter< math::Quaterniond >
math::Quaterniond	y0
	Output.
math::Quaterniond	y0
	Output.

Detailed Description

One-pole quaternion filter.

Constructor & Destructor Documentation

OnePoleQuaternion() [1/2]

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::OnePoleQuaternion::OnePoleQuaternion ( )

inline

Constructor.

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

OnePoleQuaternion() [2/2]

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

inline

Constructor.

Parameters

[in]	_fc	Cutoff frequency.
[in]	_fs	Sample rate.

References ignition::math::IGNITION_MATH_VERSION_NAMESPACE::OnePole< math::Quaterniond >::OnePole(), and ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Filter< math::Quaterniond >::Set().

Member Function Documentation

Process()

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

inline

Update the filter's output.

\paran[in] _x Input value.

Returns

The filter's current output.

References ignition::math::IGNITION_MATH_VERSION_NAMESPACE::OnePole< math::Quaterniond >::a0, and ignition::math::IGNITION_MATH_VERSION_NAMESPACE::Filter< math::Quaterniond >::y0.

---

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

• Filter.hh