Public Member Functions | Protected Attributes
filters::MedianFilter< T > Class Template Reference

A median filter which works on arrays. More...

#include <median.h>

Inheritance diagram for filters::MedianFilter< T >:
Inheritance graph
[legend]

List of all members.

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.
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.

Definition at line 97 of file median.h.


Constructor & Destructor Documentation

template<typename T >
filters::MedianFilter< T >::MedianFilter ( )

Construct the filter with the expected width and height.

Definition at line 127 of file median.h.

template<typename T >
filters::MedianFilter< T >::~MedianFilter ( )

Destructor to clean up.

Definition at line 134 of file median.h.


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 >.

Definition at line 140 of file median.h.

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_indouble array with length width
data_outdouble array with length width

Implements filters::FilterBase< T >.

Definition at line 157 of file median.h.


Member Data Documentation

template<typename T >
boost::scoped_ptr<RealtimeCircularBuffer<T > > filters::MedianFilter< T >::data_storage_ [protected]

Storage for data between updates.

Definition at line 117 of file median.h.

template<typename T >
uint32_t filters::MedianFilter< T >::number_of_observations_ [protected]

Number of observations over which to filter.

Definition at line 122 of file median.h.

template<typename T >
T filters::MedianFilter< T >::temp [protected]

Definition at line 119 of file median.h.

template<typename T >
std::vector<T> filters::MedianFilter< T >::temp_storage_ [protected]

Preallocated storage for the list to sort.

Definition at line 116 of file median.h.


The documentation for this class was generated from the following file:


filters
Author(s):
autogenerated on Wed Aug 26 2015 11:38:25