LocalGuidance
A library that generates velocity references to follow a path.
robot_utils::CumulativeMovingAverageFilter< Value_ > Class Template Reference

Cumulative Moving Average Filter. More...

#include <CumulativeMovingAverageFilter.hpp>

Public Types

typedef Value_::Scalar Scalar
 

Public Member Functions

 CumulativeMovingAverageFilter ()
 
virtual ~CumulativeMovingAverageFilter ()
 
void reset ()
 
void update (const Value_ &datum)
 
const Value_ & getValue () const
 
unsigned int getNumSamples () const
 

Protected Attributes

Value_ cumulativeMovingAverage_
 
unsigned int numCmaPointsReceived_ = 0u
 

Detailed Description

template<typename Value_>
class robot_utils::CumulativeMovingAverageFilter< Value_ >

Cumulative Moving Average Filter.

Assumes that value has method setZero(). Used with kindr objects.

Member Typedef Documentation

template<typename Value_>
typedef Value_::Scalar robot_utils::CumulativeMovingAverageFilter< Value_ >::Scalar

Constructor & Destructor Documentation

template<typename Value_>
robot_utils::CumulativeMovingAverageFilter< Value_ >::CumulativeMovingAverageFilter ( )
inline
template<typename Value_>
virtual robot_utils::CumulativeMovingAverageFilter< Value_ >::~CumulativeMovingAverageFilter ( )
inlinevirtual

Member Function Documentation

template<typename Value_>
unsigned int robot_utils::CumulativeMovingAverageFilter< Value_ >::getNumSamples ( ) const
inline
template<typename Value_>
const Value_& robot_utils::CumulativeMovingAverageFilter< Value_ >::getValue ( ) const
inline
template<typename Value_>
void robot_utils::CumulativeMovingAverageFilter< Value_ >::reset ( )
inline
template<typename Value_>
void robot_utils::CumulativeMovingAverageFilter< Value_ >::update ( const Value_ &  datum)
inline

Member Data Documentation

template<typename Value_>
Value_ robot_utils::CumulativeMovingAverageFilter< Value_ >::cumulativeMovingAverage_
protected
template<typename Value_>
unsigned int robot_utils::CumulativeMovingAverageFilter< Value_ >::numCmaPointsReceived_ = 0u
protected

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