#include <itpp/base/filter.h>
Inheritance diagram for itpp::AR_Filter< T1, T2, T3 >:
Public Member Functions | |
AR_Filter () | |
Class constructor. | |
AR_Filter (const Vec< T2 > &a) | |
Class constructor setting the coefficients in the filter. | |
virtual | ~AR_Filter () |
Class destructor. | |
Vec< T2 > | get_coeffs () const |
Filter coefficient access function. | |
void | set_coeffs (const Vec< T2 > &a) |
Set the filter coefficients (and order). | |
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. |
This class implements a autoregressive (AR) filter according to
where a 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
Definition at line 153 of file filter.h.
itpp::AR_Filter< T1, T2, T3 >::AR_Filter | ( | ) | [inline, explicit] |
itpp::AR_Filter< T1, T2, T3 >::AR_Filter | ( | const Vec< T2 > & | a | ) | [inline, explicit] |
Class constructor setting the coefficients in the filter.
Definition at line 411 of file filter.h.
References itpp::AR_Filter< T1, T2, T3 >::set_coeffs().
virtual itpp::AR_Filter< T1, T2, T3 >::~AR_Filter | ( | ) | [inline, virtual] |
Vec<T2> itpp::AR_Filter< T1, T2, T3 >::get_coeffs | ( | ) | const [inline] |
void itpp::AR_Filter< T1, T2, T3 >::set_coeffs | ( | const Vec< T2 > & | a | ) | [inline] |
Set the filter coefficients (and order).
Definition at line 417 of file filter.h.
References itpp::Vec< Num_T >::clear(), it_assert, itpp::Vec< Num_T >::set_size(), and itpp::Vec< Num_T >::size().
Referenced by itpp::AR_Filter< T1, T2, T3 >::AR_Filter().
void itpp::AR_Filter< T1, T2, T3 >::clear | ( | ) | [inline] |
Clears the filter memory.
Definition at line 166 of file filter.h.
References itpp::Vec< Num_T >::clear().
Vec< T3 > itpp::AR_Filter< T1, T2, T3 >::get_state | ( | ) | const [inline] |
Get state of filter.
Definition at line 433 of file filter.h.
References it_assert, and itpp::Vec< Num_T >::size().
Referenced by itpp::filter().
void itpp::AR_Filter< T1, T2, T3 >::set_state | ( | const Vec< T3 > & | state | ) | [inline] |
Set state of filter.
Definition at line 449 of file filter.h.
References it_assert, and itpp::Vec< Num_T >::size().
Referenced by itpp::filter().
virtual T3 itpp::Filter< T1, T2, T3 >::operator() | ( | const T1 | Sample | ) | [inline, virtual, inherited] |
Vec< T3 > itpp::Filter< T1, T2, T3 >::operator() | ( | const Vec< T1 > & | v | ) | [inline, virtual, inherited] |
Filter a vector.
Definition at line 313 of file filter.h.
References itpp::Filter< T1, T2, T3 >::filter(), and itpp::Vec< Num_T >::length().
Generated on Wed Apr 18 11:20:03 2007 for IT++ by Doxygen 1.5.2