filters::MeanFilter< T > Class Template Reference

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

#include <mean.hpp>

Inheritance diagram for filters::MeanFilter< T >:

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. More...
	MeanFilter ()
	Construct the filter with the expected width and height. More...
virtual bool	update (const T &data_in, T &data_out)
	Update the filter and return the data seperately. More...
	~MeanFilter ()
	Destructor to clean up. More...
Public Member Functions inherited from filters::FilterBase< T >
bool	configure (const std::string &param_name, ros::NodeHandle node_handle=ros::NodeHandle())
	Configure the filter from the parameter server. More...
bool	configure (XmlRpc::XmlRpcValue &config)
	The public method to configure a filter from XML. More...
	FilterBase ()
	Default constructor used by Filter Factories. More...
const std::string &	getName () const
	Get the name of the filter as a string. More...
std::string	getType ()
	Get the type of the filter as a string. More...
virtual	~FilterBase ()
	Virtual Destructor. More...

Protected Attributes
std::unique_ptr< RealtimeCircularBuffer< T > >	data_storage_
	Storage for data between updates. More...
uint32_t	last_updated_row_
	The last row to have been updated by the filter. More...
uint32_t	number_of_observations_
	Temporary storage. More...
T	temp_
Protected Attributes inherited from filters::FilterBase< T >
bool	configured_
	Whether the filter has been configured. More...
std::string	filter_name_
	The name of the filter. More...
std::string	filter_type_
	The type of the filter (Used by FilterChain for Factory construction) More...
string_map_t	params_
	Storage of the parsed xml parameters. More...

Additional Inherited Members
Protected Member Functions inherited from filters::FilterBase< T >
bool	getParam (const std::string &name, bool &value) const
	Get a filter parameter as a boolean. More...
bool	getParam (const std::string &name, double &value) const
	Get a filter parameter as a double. More...
bool	getParam (const std::string &name, int &value) const
	Get a filter parameter as a int. More...
bool	getParam (const std::string &name, std::string &value) const
	Get a filter parameter as a string. More...
bool	getParam (const std::string &name, std::vector< double > &value) const
	Get a filter parameter as a std::vector<double> More...
bool	getParam (const std::string &name, std::vector< std::string > &value) const
	Get a filter parameter as a std::vector<string> More...
bool	getParam (const std::string &name, unsigned int &value) const
	Get a filter parameter as an unsigned int. More...
bool	getParam (const std::string &name, XmlRpc::XmlRpcValue &value) const
	Get a filter parameter as a XmlRpcValue. More...
bool	loadConfiguration (XmlRpc::XmlRpcValue &config)

Detailed Description

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

A mean filter which works on doubles.

Definition at line 51 of file mean.hpp.

Constructor & Destructor Documentation

MeanFilter()

template<typename T >

filters::MeanFilter< T >::MeanFilter

Construct the filter with the expected width and height.

Definition at line 79 of file mean.hpp.

~MeanFilter()

template<typename T >

filters::MeanFilter< T >::~MeanFilter

Destructor to clean up.

Definition at line 100 of file mean.hpp.

Member Function Documentation

configure()

template<typename T >

bool filters::MeanFilter< T >::configure ( )

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 85 of file mean.hpp.

update()

template<typename T >

bool filters::MeanFilter< T >::update ( const T &  data_in, T &  data_out  )

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 106 of file mean.hpp.

Member Data Documentation

data_storage_

template<typename T >

std::unique_ptr<RealtimeCircularBuffer<T > > filters::MeanFilter< T >::data_storage_

protected

Storage for data between updates.

Definition at line 70 of file mean.hpp.

last_updated_row_

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 71 of file mean.hpp.

number_of_observations_

template<typename T >

uint32_t filters::MeanFilter< T >::number_of_observations_

protected

Temporary storage.

Number of observations over which to filter

Definition at line 73 of file mean.hpp.

temp_

template<typename T >

T filters::MeanFilter< T >::temp_

protected

Definition at line 72 of file mean.hpp.

---

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

• mean.hpp