lti::noise< T > Class Template Reference

Noise class. More...

#include <ltiNoise.h>

Inheritance diagram for lti::noise< T >:

[legend]

Collaboration diagram for lti::noise< T >:

[legend]

List of all members.

Classes
class	parameters
	scalarParameter class More...
Public Member Functions
	noise ()
	noise (const parameters &theParams)
	noise (const continuousRandomDistribution &theDistribution)
virtual	~noise ()
const parameters &	getParameters () const
virtual vector< T > &	apply (vector< T > &theObject) const
virtual vector< T > &	apply (const vector< T > &theObject, vector< T > &newObject) const
virtual matrix< T > &	apply (matrix< T > &theObject) const
virtual matrix< T > &	apply (const matrix< T > &theObject, matrix< T > &newObject) const
virtual functor *	clone () const
virtual const char *	getTypeName () const

---

Detailed Description

template<class T>
class lti::noise< T >

Noise class.

Apply puts noise of the specified distribution on the elements of the given MathObject.

Default is a default contstructed lti::gaussianDistribution.

---

Constructor & Destructor Documentation

template<class T >

lti::noise< T >::noise

(

)

default constructor

template<class T >

lti::noise< T >::noise

(

const parameters &

theParams

)

constructor, sets the parameters, i.e. the noise distribution.

template<class T >

lti::noise< T >::noise

(

const continuousRandomDistribution &

theDistribution

)

constructor, sets the noise distribution

template<class T >

virtual lti::noise< T >::~noise

(

)

[inline, virtual]

destructor

---

Member Function Documentation

template<class T >

virtual matrix<T>& lti::noise< T >::apply	(	const matrix< T > &	theObject,
		matrix< T > &	newObject
	)			const [virtual]

onCopy version of apply.

applies the functor's function to the copy of 'theObject', 'newObject'.

Implements lti::iteratingFunctor< T >.

template<class T >

virtual matrix<T>& lti::noise< T >::apply

(

matrix< T > &

theObject

)

const [virtual]

onPlace version of apply.

applies the functor's function to 'theObject'.

Implements lti::iteratingFunctor< T >.

template<class T >

virtual vector<T>& lti::noise< T >::apply	(	const vector< T > &	theObject,
		vector< T > &	newObject
	)			const [virtual]

onCopy version of apply.

applies the functor's function to the copy of 'theObject', 'newObject'.

Implements lti::iteratingFunctor< T >.

template<class T >

virtual vector<T>& lti::noise< T >::apply

(

vector< T > &

theObject

)

const [virtual]

onPlace version of apply.

applies the functor's function to 'theObject'.

Implements lti::iteratingFunctor< T >.

template<class T >

virtual functor* lti::noise< T >::clone

(

)

const [inline, virtual]

returns a pointer to a clone of the functor.

Implements lti::functor.

template<class T >

const parameters& lti::noise< T >::getParameters

(

)

const

returns the current parameters.

Reimplemented from lti::functor.

template<class T >

virtual const char* lti::noise< T >::getTypeName

(

void

)

const [inline, virtual]

returns the name of this type

Reimplemented from lti::iteratingFunctor< T >.

---

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

• ltiNoise.h