Autoregressive Moving Average (ARMA) Filter Base Class. More...
#include <itpp/signal/filter.h>
Public Member Functions | |
ARMA_Filter () | |
Class constructor. | |
ARMA_Filter (const Vec< T2 > &b, const Vec< T2 > &a) | |
Class constructor setting the coefficients in the filter. | |
virtual | ~ARMA_Filter () |
Class destructor. | |
Vec< T2 > | get_coeffs_a () const |
Filter a coefficient access function. | |
Vec< T2 > | get_coeffs_b () const |
Filter b coefficient access function. | |
void | get_coeffs (Vec< T2 > &b, Vec< T2 > &a) const |
Filter coefficient access function. | |
void | set_coeffs (const Vec< T2 > &b, 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. | |
Autoregressive Moving Average (ARMA) Filter Base Class.
This class implements a autoregressive moving average (ARMA) filter according to
where a and b are 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 Class constructor setting the coefficients in the filter.
Definition at line 496 of file filter.h.
References itpp::ARMA_Filter< T1, T2, T3 >::set_coeffs().
|
inlinevirtual |
Set the filter coefficients (and order)
Definition at line 502 of file filter.h.
References it_assert, and itpp::Array< T >::size().
Referenced by itpp::ARMA_Filter< T1, T2, T3 >::ARMA_Filter().
Clears the filter memory.
Definition at line 228 of file filter.h.
References itpp::Vec< Num_T >::clear().
Get state of filter.
Definition at line 517 of file filter.h.
References it_assert, and itpp::Array< T >::size().
Set state of filter.
Definition at line 533 of file filter.h.
References it_assert, and itpp::Array< T >::size().
Filter a single sample.
Definition at line 60 of file filter.h.
References itpp::Filter< T1, T2, T3 >::filter().
Filter a vector.
Definition at line 315 of file filter.h.
References itpp::filter(), and itpp::Array< T >::length().
Generated on Mon Jun 10 2024 11:49:33 for IT++ by Doxygen 1.9.8