IT++ Logo Newcom Logo

itpp::MA_Filter< T1, T2, T3 > Class Template Reference
[Filter Classes and Functions]

Moving Average Filter Base Class. More...

#include <itpp/base/filter.h>

Inheritance diagram for itpp::MA_Filter< T1, T2, T3 >:

itpp::Filter< T1, T2, T3 > List of all members.

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.

Detailed Description

template<class T1, class T2, class T3>
class itpp::MA_Filter< T1, T2, T3 >

Moving Average Filter Base Class.

This class implements a moving average (MA) filter according to

\[ y(n) = b(0)*x(n) + b(1)*x(n-1) + ... + b(N)*x(n-N) \]

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:

Definition at line 100 of file filter.h.


Constructor & Destructor Documentation

template<class T1, class T2, class T3>
itpp::MA_Filter< T1, T2, T3 >::MA_Filter (  )  [inline, explicit]

Class default constructor.

Definition at line 327 of file filter.h.

template<class T1, class T2, class T3>
itpp::MA_Filter< T1, T2, T3 >::MA_Filter ( const Vec< T2 > &  b  )  [inline, explicit]

Class constructor setting the coefficients in the filter.

Definition at line 334 of file filter.h.

References itpp::MA_Filter< T1, T2, T3 >::set_coeffs().

template<class T1, class T2, class T3>
virtual itpp::MA_Filter< T1, T2, T3 >::~MA_Filter (  )  [inline, virtual]

Class destructor.

Definition at line 107 of file filter.h.


Member Function Documentation

template<class T1, class T2, class T3>
Vec<T2> itpp::MA_Filter< T1, T2, T3 >::get_coeffs (  )  const [inline]

Filter coefficient access function.

Definition at line 109 of file filter.h.

template<class T1, class T2, class T3>
void itpp::MA_Filter< T1, T2, T3 >::set_coeffs ( const Vec< T2 > &  b  )  [inline]

Set the filter coefficients.

Definition at line 341 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::FIR_Fading_Generator::init(), itpp::MA_Filter< T1, T2, T3 >::MA_Filter(), itpp::Root_Raised_Cosine< T1 >::set_pulse_shape(), and itpp::Raised_Cosine< T1 >::set_pulse_shape().

template<class T1, class T2, class T3>
void itpp::MA_Filter< T1, T2, T3 >::clear (  )  [inline]

Clears the filter memory.

Definition at line 113 of file filter.h.

Referenced by itpp::Root_Raised_Cosine< T1 >::set_pulse_shape(), and itpp::Raised_Cosine< T1 >::set_pulse_shape().

template<class T1, class T2, class T3>
Vec< T3 > itpp::MA_Filter< T1, T2, T3 >::get_state (  )  const [inline]

Get state of filter.

Definition at line 353 of file filter.h.

References it_assert, and itpp::Vec< Num_T >::size().

Referenced by itpp::filter().

template<class T1, class T2, class T3>
void itpp::MA_Filter< T1, T2, T3 >::set_state ( const Vec< T3 > &  state  )  [inline]

Set state of filter.

Definition at line 369 of file filter.h.

References it_assert, and itpp::Vec< Num_T >::size().

Referenced by itpp::filter().

template<class T1, class T2, class T3>
virtual T3 itpp::Filter< T1, T2, T3 >::operator() ( const T1  Sample  )  [inline, virtual, inherited]

Filter a single sample.

Definition at line 62 of file filter.h.

template<class T1, class T2, class T3>
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().


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

Generated on Fri Jun 8 00:37:37 2007 for IT++ by Doxygen 1.5.2