#include <filter_base.hpp>
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. More... | |
| 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. More... | |
| bool | configure (unsigned int number_of_channels, XmlRpc::XmlRpcValue &config) |
| The public method to configure a filter from XML. More... | |
| bool | configure (XmlRpc::XmlRpcValue &config) |
| A method to hide the base class method and warn if improperly called. More... | |
| MultiChannelFilterBase () | |
| virtual bool | update (const std::vector< T > &data_in, std::vector< T > &data_out)=0 |
| Update the filter and return the data seperately. More... | |
| virtual bool | update (const T &, T &) |
| Update the filter and return the data seperately This is an inefficient way to do this and can be overridden in the derived class. More... | |
 Public Member Functions inherited from filters::FilterBase< T > | |
| bool | configure (const std::string ¶m_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 | |
| unsigned int | number_of_channels_ |
| How many parallel inputs for which the filter is to be configured. More... | |
| 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::MultiChannelFilterBase< T >
Definition at line 380 of file filter_base.hpp.
Constructor & Destructor Documentation
◆ MultiChannelFilterBase()
|
inline |
Definition at line 383 of file filter_base.hpp.
Member Function Documentation
◆ configure() [1/4]
|
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 >.
◆ configure() [2/4]
|
inline |
Configure the filter from the parameter server.
- Parameters
-
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 390 of file filter_base.hpp.
◆ configure() [3/4]
|
inline |
The public method to configure a filter from XML.
- Parameters
-
number_of_channels How many parallel channels the filter will process config The XmlRpcValue to load the configuration from
Definition at line 407 of file filter_base.hpp.
◆ configure() [4/4]
|
inline |
A method to hide the base class method and warn if improperly called.
Definition at line 427 of file filter_base.hpp.
◆ update() [1/2]
|
pure virtual |
Update the filter and return the data seperately.
- Parameters
-
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::MultiChannelTransferFunctionFilter< T >, filters::MultiChannelMedianFilter< T >, filters::MultiChannelMeanFilter< T >, and filters::MultiChannelIncrementFilter< T >.
◆ update() [2/2]
|
inlinevirtual |
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_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 443 of file filter_base.hpp.
Member Data Documentation
◆ number_of_channels_
|
protected |
How many parallel inputs for which the filter is to be configured.
Definition at line 456 of file filter_base.hpp.
The documentation for this class was generated from the following file: