A increment filter which works on doubles. More...
#include <increment.hpp>
Inheritance diagram for filters::IncrementFilter< 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... | |
| IncrementFilter () | |
| 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... | |
| ~IncrementFilter () | |
| Destructor to clean up. 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... | |
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) |
| 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... | |
Detailed Description
template<typename T>
class filters::IncrementFilter< T >
A increment filter which works on doubles.
Definition at line 46 of file increment.hpp.
Constructor & Destructor Documentation
◆ IncrementFilter()
template<typename T >
| filters::IncrementFilter< T >::IncrementFilter |
Construct the filter with the expected width and height.
Definition at line 68 of file increment.hpp.
◆ ~IncrementFilter()
template<typename T >
| filters::IncrementFilter< T >::~IncrementFilter |
Destructor to clean up.
Definition at line 80 of file increment.hpp.
Member Function Documentation
◆ configure()
template<typename T >
|
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 73 of file increment.hpp.
◆ update()
template<typename T >
|
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 86 of file increment.hpp.
The documentation for this class was generated from the following file: