Moving Average Filter Base Class. More...
#include <itpp/signal/filter.h>
Public Member Functions | |
MA_Filter () | |
Class default constructor. | |
MA_Filter (const Vec< T2 > &b) | |
Class constructor setting the coefficients in the filter. | |
virtual | ~MA_Filter () |
Class destructor. | |
Vec< T2 > | get_coeffs () const |
Filter coefficient access function. | |
void | set_coeffs (const Vec< T2 > &b) |
Set the filter coefficients. | |
void | clear () |
Clears the filter memory. | |
Vec< T3 > | get_state () const |
Get state of filter. | |
void | set_state (const Vec< T3 > &state) |
Set state of filter. | |
virtual T3 | operator() (const T1 Sample) |
Filter a single sample. | |
virtual Vec< T3 > | operator() (const Vec< T1 > &v) |
Filter a vector. | |
Moving Average Filter Base Class.
This class implements a moving average (MA) filter according to
where b is the filter coefficients, x is the input and y is the output.
When filtering a vector, the length of the output vector equals the length of the input vector. Internal states are kept in a filter memory. The first time the filter is used the internal states have been set to zero.
The class is templated as follows:
T1
is the type of the input samples T2
is the type of the filter coefficients T3
is the type of the output samples
|
explicit |
|
explicit |
Class constructor setting the coefficients in the filter.
Definition at line 336 of file filter.h.
References itpp::MA_Filter< T1, T2, T3 >::set_coeffs().
|
inlinevirtual |
|
inline |
void itpp::MA_Filter< T1, T2, T3 >::set_coeffs | ( | const Vec< T2 > & | b | ) |
Set the filter coefficients.
Definition at line 343 of file filter.h.
References it_assert, itpp::Vec< Num_T >::set_size(), and itpp::Vec< Num_T >::size().
Referenced by itpp::FIR_Fading_Generator::init(), and itpp::MA_Filter< T1, T2, T3 >::MA_Filter().
|
inline |
Clears the filter memory.
Definition at line 112 of file filter.h.
References itpp::Vec< Num_T >::clear().
Vec< T3 > itpp::MA_Filter< T1, T2, T3 >::get_state | ( | ) | const |
Get state of filter.
Definition at line 355 of file filter.h.
References it_assert.
Referenced by itpp::filter(), itpp::filter(), itpp::filter(), and itpp::filter().
void itpp::MA_Filter< T1, T2, T3 >::set_state | ( | const Vec< T3 > & | state | ) |
Set state of filter.
Definition at line 371 of file filter.h.
References it_assert, and itpp::Vec< Num_T >::size().
Referenced by itpp::filter(), itpp::filter(), itpp::filter(), and itpp::filter().
|
inlinevirtualinherited |
Filter a single sample.
Definition at line 60 of file filter.h.
References itpp::Filter< T1, T2, T3 >::filter().
|
virtualinherited |
Filter a vector.
Definition at line 315 of file filter.h.
References itpp::filter(), and itpp::Vec< Num_T >::length().
Generated on Tue Aug 17 2021 10:59:15 for IT++ by Doxygen 1.12.0