OnePoleVector3 Class Reference

One-pole vector3 filter. More...

#include <math/gzmath.hh>

Inherits OnePole< math::Vector3 >.

Public Member Functions
	OnePoleVector3 () GAZEBO_DEPRECATED(8.0)
	Constructor. More...
	OnePoleVector3 (double _fc, double _fs)
	Constructor. More...
virtual const math::Vector3 &	GetValue () GAZEBO_DEPRECATED(8.0)
	Get the output of the filter. More...
const math::Vector3 &	Process (const math::Vector3 &_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 math::Vector3 &_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...
math::Vector3	y0
	Output. More...

Detailed Description

One-pole vector3 filter.

Constructor & Destructor Documentation

OnePoleVector3 ( )

inline

Constructor.

References Filter< math::Vector3 >::SetValue().

OnePoleVector3 ( double  _fc, double  _fs  )

inline

Constructor.

Parameters

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

References Filter< math::Vector3 >::SetValue().

Member Function Documentation

virtual const math::Vector3 & GetValue ( )

inlinevirtualinherited

Get the output of the filter.

Returns

Filter's output.

References Filter< T >::y0.

const math::Vector3 & Process ( const math::Vector3 &  _x )

inlineinherited

Update the filter's output.

[in] _x Input value.

Returns

The filter's current output.

References OnePole< T >::a0, OnePole< T >::b1, and Filter< T >::y0.

virtual void SetFc ( double  _fc, double  _fs  )

inlinevirtualinherited

Set the cutoff frequency and sample rate.

Parameters

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

Implements Filter< math::Vector3 >.

References OnePole< T >::a0, and OnePole< T >::b1.

virtual void SetValue ( const math::Vector3 &  _val )

inlinevirtualinherited

Set the output of the filter.

Parameters

[in]

_val

New value.

Reimplemented in BiQuad< math::Vector3 >.

References Filter< T >::y0.

Referenced by OnePoleVector3::OnePoleVector3().

Member Data Documentation

double a0

protectedinherited

Input gain control.

double b1

protectedinherited

Gain of the feedback.

math::Vector3 y0

protectedinherited

Output.

---

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

• Filter.hh