stateObservation::GaussianWhiteNoise Class Reference

The class derivates the NoiseBase class to implement a gaussian white noise with a given covariance matrix, and bias. More...

#include <state-observation/noise/gaussian-white-noise.hpp>

Inheritance diagram for stateObservation::GaussianWhiteNoise:

Collaboration diagram for stateObservation::GaussianWhiteNoise:

Public Member Functions
virtual	~GaussianWhiteNoise ()
	Virtual destructor.
	GaussianWhiteNoise (Index dimension)
	The constructor that provides the dimension of the noise vector.
	GaussianWhiteNoise ()
	The default constructor.
virtual Vector	getNoisy (const Vector &)
virtual void	setStandardDeviation (const Matrix &std)
virtual void	setCovarianceMatrix (const Matrix &cov)
virtual void	setBias (const Vector &bias)
	sets the bias of the white noise
virtual void	setDimension (Index dim_)
	sets the dimension of the noise vector
virtual Index	getDimension () const
	Gets the dimension of the noise vector.
void	setSumFunction (void(*sum)(const Vector &stateVector, const Vector &tangentVector, Vector &result))
Public Member Functions inherited from stateObservation::NoiseBase
virtual	~NoiseBase ()
	Virtual destructor.

Protected Member Functions
virtual void	checkMatrix_ (const Matrix &m) const
virtual void	checkVector_ (const Vector &v) const

Protected Attributes
Index	dim_
Matrix	std_
Vector	bias_
Vector	noisy_
void(*	sum_ )(const Vector &stateVector, const Vector &tangentVector, Vector &result)

Detailed Description

The class derivates the NoiseBase class to implement a gaussian white noise with a given covariance matrix, and bias.

Constructor & Destructor Documentation

~GaussianWhiteNoise()

virtual stateObservation::GaussianWhiteNoise::~GaussianWhiteNoise ( )

inlinevirtual

Virtual destructor.

GaussianWhiteNoise() [1/2]

stateObservation::GaussianWhiteNoise::GaussianWhiteNoise

(

Index

dimension

)

The constructor that provides the dimension of the noise vector.

GaussianWhiteNoise() [2/2]

stateObservation::GaussianWhiteNoise::GaussianWhiteNoise

(

)

The default constructor.

Member Function Documentation

checkMatrix_()

virtual void stateObservation::GaussianWhiteNoise::checkMatrix_ ( const Matrix &  m ) const

protectedvirtual

checkVector_()

virtual void stateObservation::GaussianWhiteNoise::checkVector_ ( const Vector &  v ) const

protectedvirtual

getDimension()

virtual Index stateObservation::GaussianWhiteNoise::getDimension ( ) const

virtual

Gets the dimension of the noise vector.

getNoisy()

virtual Vector stateObservation::GaussianWhiteNoise::getNoisy ( const Vector &  )

virtual

get the noisy version of a given vector it is only an addition of a given vector and a gaussian white noise

Implements stateObservation::NoiseBase.

setBias()

virtual void stateObservation::GaussianWhiteNoise::setBias ( const Vector &  bias )

virtual

sets the bias of the white noise

setCovarianceMatrix()

virtual void stateObservation::GaussianWhiteNoise::setCovarianceMatrix ( const Matrix &  cov )

virtual

Sets the covariance matrix, the covariance matrix must be positive semi definite. This method makes a cholesky decomposition to recompute the standard deviation

setDimension()

virtual void stateObservation::GaussianWhiteNoise::setDimension ( Index  dim_ )

virtual

sets the dimension of the noise vector

setStandardDeviation()

virtual void stateObservation::GaussianWhiteNoise::setStandardDeviation ( const Matrix &  std )

virtual

Sets the standard deviation of the Gaussian white noise. The covariance matrix is then std*std.transpose()

setSumFunction()

void stateObservation::GaussianWhiteNoise::setSumFunction

(

void(*)(const Vector &stateVector, const Vector &tangentVector, Vector &result)

sum

)

set update functions for sum for a vector (used in case of lie group vectors)

Member Data Documentation

bias_

Vector stateObservation::GaussianWhiteNoise::bias_

protected

dim_

Index stateObservation::GaussianWhiteNoise::dim_

protected

noisy_

Vector stateObservation::GaussianWhiteNoise::noisy_

protected

std_

Matrix stateObservation::GaussianWhiteNoise::std_

protected

sum_

void(* stateObservation::GaussianWhiteNoise::sum_) (const Vector &stateVector, const Vector &tangentVector, Vector &result)

protected

---

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

• include/state-observation/noise/gaussian-white-noise.hpp