filters::MeanFilter< T > Class Template Reference

A mean filter which works on doubles. More...

#include <mean.h>

Inheritance diagram for filters::MeanFilter< T >:

[legend]

List of all members.

Public Member Functions
virtual bool	configure ()
	Pure virtual function for the sub class to configure the filter This function must be implemented in the derived class.
	MeanFilter ()
	Construct the filter with the expected width and height.
virtual bool	update (const T &data_in, T &data_out)
	Update the filter and return the data seperately.
	~MeanFilter ()
	Destructor to clean up.
Protected Attributes
boost::scoped_ptr < RealtimeCircularBuffer< T > >	data_storage_
	Storage for data between updates.
uint32_t	last_updated_row_
	The last row to have been updated by the filter.
uint32_t	number_of_observations_
	Temporary storage.
T	temp_

---

Detailed Description

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

A mean filter which works on doubles.

Definition at line 49 of file mean.h.

---

Constructor & Destructor Documentation

template<typename T >

filters::MeanFilter< T >::MeanFilter

(

)

[inline]

Construct the filter with the expected width and height.

Definition at line 77 of file mean.h.

template<typename T >

filters::MeanFilter< T >::~MeanFilter

(

)

[inline]

Destructor to clean up.

Definition at line 98 of file mean.h.

---

Member Function Documentation

template<typename T >

bool filters::MeanFilter< T >::configure

(

)

[inline, virtual]

Pure virtual function for the sub class to configure the filter This function must be implemented in the derived class.

Implements filters::FilterBase< T >.

Definition at line 83 of file mean.h.

template<typename T >

bool filters::MeanFilter< T >::update	(	const T &	data_in,
		T &	data_out
	)			[inline, virtual]

Update the filter and return the data seperately.

Parameters:

	data_in	T array with length width
	data_out	T array with length width

Implements filters::FilterBase< T >.

Definition at line 104 of file mean.h.

---

Member Data Documentation

template<typename T>

boost::scoped_ptr<RealtimeCircularBuffer<T > > filters::MeanFilter< T >::data_storage_ [protected]

Storage for data between updates.

Definition at line 61 of file mean.h.

template<typename T>

uint32_t filters::MeanFilter< T >::last_updated_row_ [protected]

The last row to have been updated by the filter.

Definition at line 62 of file mean.h.

template<typename T>

uint32_t filters::MeanFilter< T >::number_of_observations_ [protected]

Temporary storage.

Number of observations over which to filter

Definition at line 64 of file mean.h.

template<typename T>

T filters::MeanFilter< T >::temp_ [protected]

Definition at line 63 of file mean.h.

---

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

• mean.h