Autoware.Auto
autoware::common::signal_filters::LowPassFilter< T, ClockT > Class Template Reference

#include <low_pass_filter.hpp>

Inheritance diagram for autoware::common::signal_filters::LowPassFilter< T, ClockT >:
Collaboration diagram for autoware::common::signal_filters::LowPassFilter< T, ClockT >:

Public Member Functions

 LowPassFilter (T cutoff_frequency_hz)
 
virtual ~LowPassFilter ()=default
 Destructor. More...
 
- Public Member Functions inherited from autoware::common::signal_filters::FilterBase< T, std::chrono::steady_clock >
virtual ~FilterBase ()=default
 Destructor. More...
 
filter (T value, typename clock_type::time_point time_stamp)
 
filter (T value, std::chrono::nanoseconds duration)
 

Protected Member Functions

filter_impl (T value, std::chrono::nanoseconds duration) override
 Actual implementation, error checking already done, can assume duration is positive. More...
 
- Protected Member Functions inherited from autoware::common::signal_filters::FilterBase< T, std::chrono::steady_clock >
filter_impl_checked (T value, std::chrono::nanoseconds duration)
 Underlying implementation, with error checking. More...
 

Additional Inherited Members

- Public Types inherited from autoware::common::signal_filters::FilterBase< T, std::chrono::steady_clock >
using clock_type = std::chrono::steady_clock
 
using signal_type = T
 

Detailed Description

template<typename T, typename ClockT = std::chrono::steady_clock>
class autoware::common::signal_filters::LowPassFilter< T, ClockT >

Basic low pass filter implemented as an exponential moving average

Template Parameters
TA floating point type for the signal

Constructor & Destructor Documentation

◆ LowPassFilter()

template<typename T , typename ClockT = std::chrono::steady_clock>
autoware::common::signal_filters::LowPassFilter< T, ClockT >::LowPassFilter ( cutoff_frequency_hz)
inlineexplicit

◆ ~LowPassFilter()

template<typename T , typename ClockT = std::chrono::steady_clock>
virtual autoware::common::signal_filters::LowPassFilter< T, ClockT >::~LowPassFilter ( )
virtualdefault

Destructor.

Member Function Documentation

◆ filter_impl()

template<typename T , typename ClockT = std::chrono::steady_clock>
T autoware::common::signal_filters::LowPassFilter< T, ClockT >::filter_impl ( value,
std::chrono::nanoseconds  duration 
)
inlineoverrideprotectedvirtual

Actual implementation, error checking already done, can assume duration is positive.

Implements autoware::common::signal_filters::FilterBase< T, std::chrono::steady_clock >.


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