Public Member Functions | Protected Attributes
filters::MultiChannelFilterBase< T > Class Template Reference

#include <filter_base.h>

Inheritance diagram for filters::MultiChannelFilterBase< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

bool configure (unsigned int number_of_channels, const std::string &param_name, ros::NodeHandle node_handle=ros::NodeHandle())
 Configure the filter from the parameter server.
bool configure (unsigned int number_of_channels, XmlRpc::XmlRpcValue &config)
 The public method to configure a filter from XML.
bool configure (XmlRpc::XmlRpcValue &config)
 A method to hide the base class method and warn if improperly called.
virtual bool configure ()=0
 Pure virtual function for the sub class to configure the filter This function must be implemented in the derived class.
 MultiChannelFilterBase ()
virtual bool update (const std::vector< T > &data_in, std::vector< T > &data_out)=0
 Update the filter and return the data seperately.
virtual bool update (const T &data_in, T &data_out)
 Update the filter and return the data seperately This is an inefficient way to do this and can be overridden in the derived class.

Protected Attributes

unsigned int number_of_channels_
 How many parallel inputs for which the filter is to be configured.

Detailed Description

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

Definition at line 357 of file filter_base.h.


Constructor & Destructor Documentation

template<typename T>
filters::MultiChannelFilterBase< T >::MultiChannelFilterBase ( ) [inline]

Definition at line 360 of file filter_base.h.


Member Function Documentation

template<typename T>
bool filters::MultiChannelFilterBase< T >::configure ( unsigned int  number_of_channels,
const std::string &  param_name,
ros::NodeHandle  node_handle = ros::NodeHandle() 
) [inline]

Configure the filter from the parameter server.

Parameters:
number_of_channelsHow many parallel channels the filter will process
Theparameter from which to read the configuration
node_handleThe optional node handle, useful if operating in a different namespace.

Definition at line 367 of file filter_base.h.

template<typename T>
bool filters::MultiChannelFilterBase< T >::configure ( unsigned int  number_of_channels,
XmlRpc::XmlRpcValue config 
) [inline]

The public method to configure a filter from XML.

Parameters:
number_of_channelsHow many parallel channels the filter will process
configThe XmlRpcValue to load the configuration from

Definition at line 384 of file filter_base.h.

template<typename T>
bool filters::MultiChannelFilterBase< T >::configure ( XmlRpc::XmlRpcValue config) [inline]

A method to hide the base class method and warn if improperly called.

Reimplemented from filters::FilterBase< T >.

Definition at line 404 of file filter_base.h.

template<typename T>
virtual bool filters::MultiChannelFilterBase< T >::configure ( ) [pure 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 >.

Implemented in filters::MultiChannelTransferFunctionFilter< T >, filters::MultiChannelMedianFilter< T >, filters::MultiChannelMeanFilter< T >, and filters::MultiChannelIncrementFilter< T >.

template<typename T>
virtual bool filters::MultiChannelFilterBase< T >::update ( const std::vector< T > &  data_in,
std::vector< T > &  data_out 
) [pure virtual]

Update the filter and return the data seperately.

Parameters:
data_inA reference to the data to be input to the filter
data_outA reference to the data output location This funciton must be implemented in the derived class.

Implemented in filters::MultiChannelTransferFunctionFilter< T >, filters::MultiChannelMedianFilter< T >, filters::MultiChannelMeanFilter< T >, and filters::MultiChannelIncrementFilter< T >.

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

Update the filter and return the data seperately This is an inefficient way to do this and can be overridden in the derived class.

Parameters:
data_inA reference to the data to be input to the filter
data_outA reference to the data output location

Implements filters::FilterBase< T >.

Definition at line 420 of file filter_base.h.


Member Data Documentation

template<typename T>
unsigned int filters::MultiChannelFilterBase< T >::number_of_channels_ [protected]

How many parallel inputs for which the filter is to be configured.

Definition at line 433 of file filter_base.h.


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


filters
Author(s):
autogenerated on Wed Aug 26 2015 11:38:25