Ignition Math

API Reference

6.8.0
MovingWindowFilter< T > Class Template Reference

Base class for MovingWindowFilter. This replaces the version of MovingWindowFilter in the Ignition Common library. More...

#include <MovingWindowFilter.hh>

Public Member Functions

 MovingWindowFilter ()
 Constructor. More...
 
virtual ~MovingWindowFilter ()
 Destructor. More...
 
void SetWindowSize (const unsigned int _n)
 Set window size. More...
 
void Update (const T _val)
 Update value of filter. More...
 
Value () const
 Get filtered result. More...
 
bool WindowFilled () const
 Get whether the window has been filled. More...
 
unsigned int WindowSize () const
 Get the window size. More...
 

Detailed Description

template<typename T>
class ignition::math::MovingWindowFilter< T >

Base class for MovingWindowFilter. This replaces the version of MovingWindowFilter in the Ignition Common library.

The default window size is 4.

Constructor & Destructor Documentation

◆ MovingWindowFilter()

Constructor.

◆ ~MovingWindowFilter()

~MovingWindowFilter ( )
virtual

Destructor.

Member Function Documentation

◆ SetWindowSize()

void SetWindowSize ( const unsigned int  _n)

Set window size.

Parameters
[in]_nnew desired window size

◆ Update()

void Update ( const T  _val)

Update value of filter.

Parameters
[in]_valnew raw value

◆ Value()

T Value ( ) const

Get filtered result.

Returns
Latest filtered value

◆ WindowFilled()

bool WindowFilled ( ) const

Get whether the window has been filled.

Returns
True if the window has been filled.

◆ WindowSize()

unsigned int WindowSize ( ) const

Get the window size.

Returns
The size of the moving window.

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