A mean filter which works on doubles. More...
#include <mean.h>
Inheritance diagram for filters::MeanFilter< 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. | |
| MeanFilter () | |
| Construct the filter with the expected width and height. | |
| virtual bool | update (const T &data_in, T &data_out) |
| Update the filter and return the data seperately. | |
| ~MeanFilter () | |
| Destructor to clean up. | |
Protected Attributes | |
| boost::scoped_ptr < RealtimeCircularBuffer< T > > | data_storage_ |
| Storage for data between updates. | |
| uint32_t | last_updated_row_ |
| The last row to have been updated by the filter. | |
| uint32_t | number_of_observations_ |
| Temporary storage. | |
| T | temp_ |
Detailed Description
template<typename T>
class filters::MeanFilter< T >
A mean filter which works on doubles.
Constructor & Destructor Documentation
template<typename T >
| filters::MeanFilter< T >::MeanFilter | ( | ) |
template<typename T >
| filters::MeanFilter< T >::~MeanFilter | ( | ) |
Member Function Documentation
template<typename T >
| bool filters::MeanFilter< T >::configure | ( | ) | [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 >.
template<typename T >
| bool filters::MeanFilter< T >::update | ( | const T & | data_in, |
| T & | data_out | ||
| ) | [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 >.
Member Data Documentation
template<typename T>
boost::scoped_ptr<RealtimeCircularBuffer<T > > filters::MeanFilter< T >::data_storage_ [protected] |
template<typename T>
uint32_t filters::MeanFilter< T >::last_updated_row_ [protected] |
template<typename T>
uint32_t filters::MeanFilter< T >::number_of_observations_ [protected] |
template<typename T>
T filters::MeanFilter< T >::temp_ [protected] |
The documentation for this class was generated from the following file: