A mean filter which works on double arrays. More...
#include <mean.hpp>
Inheritance diagram for filters::MultiChannelMeanFilter< 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... | |
| MultiChannelMeanFilter () | |
| Construct the filter with the expected width and height. More... | |
| virtual bool | update (const std::vector< T > &data_in, std::vector< T > &data_out) |
| Update the filter and return the data seperately. More... | |
| ~MultiChannelMeanFilter () | |
| Destructor to clean up. More... | |
 Public Member Functions inherited from filters::MultiChannelFilterBase< T > | |
| 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 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 | |
| std::unique_ptr< RealtimeCircularBuffer< std::vector< 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_ |
| Number of observations over which to filter. More... | |
| std::vector< T > | temp |
| Protected Attributes inherited from filters::MultiChannelFilterBase< T > | |
| 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::MultiChannelMeanFilter< T >
A mean filter which works on double arrays.
Constructor & Destructor Documentation
◆ MultiChannelMeanFilter()
template<typename T >
| filters::MultiChannelMeanFilter< T >::MultiChannelMeanFilter |
◆ ~MultiChannelMeanFilter()
template<typename T >
| filters::MultiChannelMeanFilter< T >::~MultiChannelMeanFilter |
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::MultiChannelFilterBase< T >.
◆ 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::MultiChannelFilterBase< T >.
Member Data Documentation
◆ data_storage_
template<typename T >
|
protected |
◆ last_updated_row_
template<typename T >
|
protected |
◆ number_of_observations_
template<typename T >
|
protected |
◆ temp
template<typename T >
|
protected |
The documentation for this class was generated from the following file: