Template Class ExponentialFilter

Inheritance Relationships

Base Type

  • public filters::FilterBase< T >

Class Documentation

template<typename T>
class ExponentialFilter : public filters::FilterBase<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.

Public Functions

virtual bool configure() override

Configure the ExponentialFilter (access and process params).

virtual bool 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