$search
#include <filter_base.h>
Public Member Functions | |
virtual bool | configure ()=0 |
Pure virtual function for the sub class to configure the filter This function must be implemented in the derived class. | |
bool | configure (XmlRpc::XmlRpcValue &config) |
A method to hide the base class method and warn if improperly called. | |
bool | configure (unsigned int number_of_channels, XmlRpc::XmlRpcValue &config) |
The public method to configure a filter from XML. | |
bool | configure (unsigned int number_of_channels, const std::string ¶m_name, ros::NodeHandle node_handle=ros::NodeHandle()) |
Configure the filter from the parameter server. | |
MultiChannelFilterBase () | |
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. | |
virtual bool | update (const std::vector< T > &data_in, std::vector< T > &data_out)=0 |
Update the filter and return the data seperately. | |
Protected Attributes | |
unsigned int | number_of_channels_ |
How many parallel inputs for which the filter is to be configured. |
Definition at line 357 of file filter_base.h.
filters::MultiChannelFilterBase< T >::MultiChannelFilterBase | ( | ) | [inline] |
Definition at line 360 of file filter_base.h.
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::MultiChannelIncrementFilter< T >, filters::MultiChannelMeanFilter< T >, filters::MultiChannelMedianFilter< T >, and filters::MultiChannelTransferFunctionFilter< 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.
bool filters::MultiChannelFilterBase< T >::configure | ( | unsigned int | number_of_channels, | |
XmlRpc::XmlRpcValue & | config | |||
) | [inline] |
The public method to configure a filter from XML.
number_of_channels | How many parallel channels the filter will process | |
config | The XmlRpcValue to load the configuration from |
Definition at line 384 of file filter_base.h.
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.
number_of_channels | How many parallel channels the filter will process | |
The | parameter from which to read the configuration | |
node_handle | The optional node handle, useful if operating in a different namespace. |
Definition at line 367 of file filter_base.h.
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.
data_in | A reference to the data to be input to the filter | |
data_out | A reference to the data output location |
Implements filters::FilterBase< T >.
Definition at line 420 of file filter_base.h.
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.
data_in | A reference to the data to be input to the filter | |
data_out | A reference to the data output location This funciton must be implemented in the derived class. |
Implemented in filters::MultiChannelIncrementFilter< T >, filters::MultiChannelMeanFilter< T >, filters::MultiChannelMedianFilter< T >, and filters::MultiChannelTransferFunctionFilter< 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.