A median filter which works on arrays. More...
#include <median.h>
Inheritance diagram for filters::MedianFilter< 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. | |
| MedianFilter () | |
| 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. | |
| ~MedianFilter () | |
| Destructor to clean up. | |
Protected Attributes | |
| boost::scoped_ptr < RealtimeCircularBuffer< T > > | data_storage_ |
| Storage for data between updates. | |
| uint32_t | number_of_observations_ |
| Number of observations over which to filter. | |
| T | temp |
| std::vector< T > | temp_storage_ |
| Preallocated storage for the list to sort. | |
Detailed Description
template<typename T>
class filters::MedianFilter< T >
A median filter which works on arrays.
Constructor & Destructor Documentation
template<typename T >
| filters::MedianFilter< T >::MedianFilter | ( | ) |
template<typename T >
| filters::MedianFilter< T >::~MedianFilter | ( | ) |
Member Function Documentation
template<typename T >
| bool filters::MedianFilter< 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::MedianFilter< T >::update | ( | const T & | data_in, |
| T & | data_out | ||
| ) | [virtual] |
Update the filter and return the data seperately.
- Parameters:
-
data_in double array with length width data_out double array with length width
Implements filters::FilterBase< T >.
Member Data Documentation
template<typename T >
boost::scoped_ptr<RealtimeCircularBuffer<T > > filters::MedianFilter< T >::data_storage_ [protected] |
template<typename T >
uint32_t filters::MedianFilter< T >::number_of_observations_ [protected] |
template<typename T >
T filters::MedianFilter< T >::temp [protected] |
template<typename T >
std::vector<T> filters::MedianFilter< T >::temp_storage_ [protected] |
The documentation for this class was generated from the following file: