vmml::lowpass_filter< M, T > Class Template Reference

Collaboration diagram for vmml::lowpass_filter< M, T >:

Public Member Functions
	lowpass_filter (const float F)
	Constructor. More...
const T &	get () const
	Filter the content of the data structure. More...
const T *	operator-> () const
	Access the filtered value. More...
const T &	operator* () const
	Access the filtered value. More...
T	add (const T &value)
	Add a value to the data set and return the filtered output. More...
void	set_smooth_factor (const float &f)
	Sets the smooth factor. More...

Detailed Description

template<size_t M, typename T>
class vmml::lowpass_filter< M, T >

Definition at line 46 of file lowpass_filter.hpp.

Constructor & Destructor Documentation

template<size_t M, typename T >

vmml::lowpass_filter< M, T >::lowpass_filter ( const float  F )

inline

Constructor.

Parameters

[in]

F

Smooth factor to use during the filter process

Definition at line 53 of file lowpass_filter.hpp.

Member Function Documentation

template<size_t M, typename T >

T vmml::lowpass_filter< M, T >::add

(

const T &

value

)

Add a value to the data set and return the filtered output.

Parameters

[in]

value

Value to add

Returns

The filtered output value

Definition at line 88 of file lowpass_filter.hpp.

template<size_t M, typename T >

const T& vmml::lowpass_filter< M, T >::get ( ) const

inline

Filter the content of the data structure.

Returns

The filtered output value

Definition at line 60 of file lowpass_filter.hpp.

template<size_t M, typename T >

const T& vmml::lowpass_filter< M, T >::operator* ( ) const

inline

Access the filtered value.

Definition at line 66 of file lowpass_filter.hpp.

template<size_t M, typename T >

const T* vmml::lowpass_filter< M, T >::operator-> ( ) const

inline

Access the filtered value.

Definition at line 63 of file lowpass_filter.hpp.

template<size_t M, typename T >

void vmml::lowpass_filter< M, T >::set_smooth_factor

(

const float &

f

)

Sets the smooth factor.

Parameters

[in]

f

Smooth factor to use during the filter process

Definition at line 110 of file lowpass_filter.hpp.

---

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

• lowpass_filter.hpp