filters::MultiChannelMedianFilter< T > Class Template Reference

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

#include <median.h>

Inheritance diagram for filters::MultiChannelMedianFilter< 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.
 MultiChannelMedianFilter ()
 Construct the filter with the expected width and height.
virtual bool update (const std::vector< T > &data_in, std::vector< T > &data_out)
 Update the filter and return the data seperately.
 ~MultiChannelMedianFilter ()
 Destructor to clean up.

Protected Attributes

boost::scoped_ptr
< RealtimeCircularBuffer
< std::vector< T > > > 
data_storage_
 Storage for data between updates.
uint32_t number_of_observations_
 Number of observations over which to filter.
std::vector< T > temp
std::vector< T > temp_storage_
 Preallocated storage for the list to sort.

Detailed Description

template<typename T>
class filters::MultiChannelMedianFilter< T >

A median filter which works on arrays.

Definition at line 181 of file median.h.


Constructor & Destructor Documentation

template<typename T >
filters::MultiChannelMedianFilter< T >::MultiChannelMedianFilter (  )  [inline]

Construct the filter with the expected width and height.

Definition at line 211 of file median.h.

template<typename T >
filters::MultiChannelMedianFilter< T >::~MultiChannelMedianFilter (  )  [inline]

Destructor to clean up.

Definition at line 218 of file median.h.


Member Function Documentation

template<typename T >
bool filters::MultiChannelMedianFilter< T >::configure (  )  [inline, 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 >.

Definition at line 224 of file median.h.

template<typename T >
bool filters::MultiChannelMedianFilter< T >::update ( const std::vector< T > &  data_in,
std::vector< T > &  data_out 
) [inline, 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::MultiChannelFilterBase< T >.

Definition at line 242 of file median.h.


Member Data Documentation

template<typename T>
boost::scoped_ptr<RealtimeCircularBuffer<std::vector<T> > > filters::MultiChannelMedianFilter< T >::data_storage_ [protected]

Storage for data between updates.

Definition at line 201 of file median.h.

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

Number of observations over which to filter.

Definition at line 206 of file median.h.

template<typename T>
std::vector<T> filters::MultiChannelMedianFilter< T >::temp [protected]

Definition at line 203 of file median.h.

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

Preallocated storage for the list to sort.

Definition at line 200 of file median.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Defines


filters
Author(s): Tully Foote/tfoote@willowgarage.com
autogenerated on Fri Jan 11 09:33:18 2013