control_filters::ExponentialFilter< T > Class Template Reference

A exponential filter class. More...

#include <exponential_filter.hpp>

Inheritance diagram for control_filters::ExponentialFilter< T >:

Collaboration diagram for control_filters::ExponentialFilter< T >:

Public Member Functions
bool	configure () override
	Configure the ExponentialFilter (access and process params).
bool	update (const T &data_in, T &data_out) override
	Applies one iteration of the exponential filter.

Detailed Description

template<typename T>
class control_filters::ExponentialFilter< T >

A exponential filter class.

This class implements a low-pass filter for various data types.

Usage

The ExponentialFilter class is meant to be instantiated as a filter in a controller but can also be used elsewhere. For manual instantiation, you should first call configure() (in non-realtime) and then call update() at every update step.

Member Function Documentation

update()

template<typename T >

bool control_filters::ExponentialFilter< T >::update ( const T &  data_in, T &  data_out  )

override

Applies one iteration of the exponential filter.

Parameters

data_in	input to the filter
data_out	filtered output

Returns

false if filter is not configured, true otherwise

---

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

• control_toolbox/include/control_filters/exponential_filter.hpp