The RTFilterBase class is the base class for all real time capable filters. More...

#include <ArmarXCore/observers/filters/rtfilters/RTFilterBase.h>

Inheritance diagram for RTFilterBase:

Public Member Functions
virtual double	calculate ()=0

virtual RTFilterBasePtr	clone () const =0

double	getCurrentValue () const

virtual void	reset ()

	RTFilterBase (const RTFilterBase &other)=default

	RTFilterBase (size_t historySize)

double	update (double deltaSec, double newValue)

virtual double	update (IceUtil::Time const &timestamp, double newValue)

virtual	~RTFilterBase ()

Protected Attributes
double	currentValue = 0.0

boost::circular_buffer< std::pair< IceUtil::Time, double > >	dataHistory

Detailed Description

The RTFilterBase class is the base class for all real time capable filters.

Real Time capable means here that no heap memory allocation is done and no mutexes are locked during the update() function. Also the runtime must be the same during each call (e.g. no random searches).

Constructor & Destructor Documentation

◆ RTFilterBase() [1/2]

RTFilterBase ( size_t historySize )

◆ RTFilterBase() [2/2]

RTFilterBase ( const RTFilterBase & other )

default

◆ ~RTFilterBase()

virtual ~RTFilterBase ( )

inlinevirtual

Member Function Documentation

◆ calculate()

virtual double calculate ( )

pure virtual

Implemented in AverageFilter, ButterworthFilter, GaussianFilter, MedianFilter, and TimeWindowAverageFilter.

◆ clone()

virtual RTFilterBasePtr clone ( ) const

pure virtual

Implemented in AverageFilter, ButterworthFilter, GaussianFilter, MedianFilter, and TimeWindowAverageFilter.

◆ getCurrentValue()

double getCurrentValue ( ) const

◆ reset()

void reset ( )

virtual

◆ update() [1/2]

double update	(	double	deltaSec,
		double	newValue )

◆ update() [2/2]

double update	(	IceUtil::Time const &	timestamp,
		double	newValue )

virtual

Reimplemented in ButterworthFilter.

Member Data Documentation

◆ currentValue

double currentValue = 0.0

protected

◆ dataHistory

boost::circular_buffer<std::pair<IceUtil::Time, double> > dataHistory