filters::MultiChannelTransferFunctionFilter< T > Class Template Reference

One-dimensional digital filter class. More...

#include <transfer_function.h>

Inheritance diagram for filters::MultiChannelTransferFunctionFilter< T >:

Public Member Functions
virtual bool	configure ()
	Configure the filter with the correct number of channels and params.
	MultiChannelTransferFunctionFilter ()
	Construct the filter.
virtual bool	update (const std::vector< T > &data_in, std::vector< T > &data_out)
	Update the filter and return the data seperately.
	~MultiChannelTransferFunctionFilter ()
	Destructor to clean up.
Protected Attributes
std::vector< double >	a_
std::vector< double >	b_
boost::scoped_ptr < RealtimeCircularBuffer < std::vector< T > > >	input_buffer_
boost::scoped_ptr < RealtimeCircularBuffer < std::vector< T > > >	output_buffer_
std::vector< T >	temp_

Detailed Description

template<typename T>
class filters::MultiChannelTransferFunctionFilter< T >

One-dimensional digital filter class.

This class calculates the output for $N$ one-dimensional digital filters. Where the input, $x$ , is a ( $N$ x 1) vector of inputs and the output, $y$ , is a ( $N$ x 1) vector of outputs. The filter is described by vectors $a$ and $b$ and implemented using the standard difference equation:

$\begin{eqnarray*} a[0]*y[n] = b[0]*x[n] &+& b[1]*x[n-1]+ ... + b[n_b]*x[n-n_b]\\ &-& a[1]*y[n-1]- ... - a[n_a]*y[n-n_a] \end{eqnarray*}$

If $a[0]$ is not equal to 1, the coefficients are normalized by $a[0]$ .

Example xml config:

Definition at line 225 of file transfer_function.h.

Constructor & Destructor Documentation

template<typename T >

filters::MultiChannelTransferFunctionFilter< T >::MultiChannelTransferFunctionFilter ( ) [inline]

Construct the filter.

Definition at line 264 of file transfer_function.h.

template<typename T >

filters::MultiChannelTransferFunctionFilter< T >::~MultiChannelTransferFunctionFilter ( ) [inline]

Destructor to clean up.

Definition at line 269 of file transfer_function.h.

Member Function Documentation

template<typename T >

bool filters::MultiChannelTransferFunctionFilter< T >::configure ( ) [inline, virtual]

Configure the filter with the correct number of channels and params.

Parameters:

	number_of_channels	The number of inputs filtered.
	config	The xml that is parsed to configure the filter.

Todo:: check length

Todo:: check length

Implements filters::MultiChannelFilterBase< T >.

Definition at line 274 of file transfer_function.h.

template<typename T >

bool filters::MultiChannelTransferFunctionFilter< T >::update	(	const std::vector< T > &	data_in,
		std::vector< T > &	data_out
	)			`[inline, virtual]`

Update the filter and return the data seperately.

Parameters:

	data_in	vector<T> with number_of_channels elements
	data_out	vector<T> with number_of_channels elements

Implements filters::MultiChannelFilterBase< T >.

Definition at line 321 of file transfer_function.h.

Member Data Documentation

template<typename T>

std::vector<double> filters::MultiChannelTransferFunctionFilter< T >::a_ [protected]

Definition at line 258 of file transfer_function.h.

template<typename T>

std::vector<double> filters::MultiChannelTransferFunctionFilter< T >::b_ [protected]

Definition at line 259 of file transfer_function.h.

template<typename T>

boost::scoped_ptr<RealtimeCircularBuffer<std::vector<T> > > filters::MultiChannelTransferFunctionFilter< T >::input_buffer_ [protected]

Definition at line 253 of file transfer_function.h.

template<typename T>

boost::scoped_ptr<RealtimeCircularBuffer<std::vector<T> > > filters::MultiChannelTransferFunctionFilter< T >::output_buffer_ [protected]

Definition at line 254 of file transfer_function.h.

template<typename T>

std::vector<T> filters::MultiChannelTransferFunctionFilter< T >::temp_ [protected]

Definition at line 256 of file transfer_function.h.

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

transfer_function.h

filters::MultiChannelTransferFunctionFilter< T > Class Template Reference

Public Member Functions

Protected Attributes

Detailed Description

template<typename T> class filters::MultiChannelTransferFunctionFilter< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class filters::MultiChannelTransferFunctionFilter< T >