sdf::v9::Noise Class Reference

The Noise class contains information about a noise model, such as a Gaussian distribution. More...

#include <Noise.hh>

## Public Member Functions

Noise ()
Default constructor. More...

Noise (const Noise &_noise)
Copy constructor. More...

Noise (Noise &&_noise) noexcept
Move constructor. More...

~Noise ()
Destructor. More...

double BiasMean () const
Get the mean of the Gaussian distribution from which bias values are drawn. More...

double BiasStdDev () const
Get the standard deviation of the Gaussian distribution from which bias values are drawn. More...

double DynamicBiasCorrelationTime () const
For type "gaussian*", get the correlation time of the noise used to drive a process to model slow variations in a sensor bias. More...

double DynamicBiasStdDev () const
For type "gaussian*", get the standard deviation of the noise used to drive a process to model slow variations in a sensor bias. More...

sdf::ElementPtr Element () const
Get a pointer to the SDF element that was used during load. More...

Load the noise based on a element pointer. More...

double Mean () const
Get the mean of the Gaussian distribution from which noise values are drawn. More...

bool operator!= (const Noise &_noise) const
Return true the Noise objects do not contain the same values. More...

Noiseoperator= (const Noise &_noise)
Assignment operator. More...

Noiseoperator= (Noise &&_noise)
Move assignment operator. More...

bool operator== (const Noise &_noise) const
Return true if both Noise objects contain the same values. More...

double Precision () const
For type "gaussian_quantized", get the precision of output signals. More...

void SetBiasMean (double _bias)
Set the mean of the Gaussian distribution from which bias values are drawn. More...

void SetBiasStdDev (double _bias)
Set the standard deviation of the Gaussian distribution from which bias values are drawn. More...

void SetDynamicBiasCorrelationTime (double _time)
For type "gaussian*", set the correlation time in seconds of the noise used to drive a process to model slow variations in a sensor bias.A typical value, when used, would be on the order of 3600 seconds (1 hour). More...

void SetDynamicBiasStdDev (double _stddev)
For type "gaussian*", set the standard deviation of the noise used to drive a process to model slow variations in a sensor bias. More...

void SetMean (double _mean)
Set the mean of the Gaussian distribution from which noise values are drawn. More...

void SetPrecision (double _precision)
For type "gaussian_quantized", set the precision of output signals. More...

void SetStdDev (double _stddev)
Set the standard deviation of the Gaussian distribution from which noise values are drawn. More...

void SetType (NoiseType _type)
Set the type of noise. More...

double StdDev () const
Get the standard deviation of the Gaussian distribution from which noise values are drawn. More...

NoiseType Type () const
Get the type of noise. More...

## Detailed Description

The Noise class contains information about a noise model, such as a Gaussian distribution.

A Noise DOM object is typically available from a Sensor.

## ◆ Noise() [1/3]

 sdf::v9::Noise::Noise ( )

Default constructor.

## ◆ Noise() [2/3]

 sdf::v9::Noise::Noise ( const Noise & _noise )

Copy constructor.

Parameters
 [in] _noise Noise to copy.

## ◆ Noise() [3/3]

 sdf::v9::Noise::Noise ( Noise && _noise )
noexcept

Move constructor.

Parameters
 [in] _noise Noise to move.

## ◆ ~Noise()

 sdf::v9::Noise::~Noise ( )

Destructor.

## ◆ BiasMean()

 double sdf::v9::Noise::BiasMean ( ) const

Get the mean of the Gaussian distribution from which bias values are drawn.

This is applicable to "gaussian*" noise types.

Returns
The mean of the bias Guassian distribution.

## ◆ BiasStdDev()

 double sdf::v9::Noise::BiasStdDev ( ) const

Get the standard deviation of the Gaussian distribution from which bias values are drawn.

This is applicable to "gaussian*" noise types.

Returns
The standard deviation of the bias Guassian distribution.

## ◆ DynamicBiasCorrelationTime()

 double sdf::v9::Noise::DynamicBiasCorrelationTime ( ) const

For type "gaussian*", get the correlation time of the noise used to drive a process to model slow variations in a sensor bias.

Returns
The dynamic bias correlation time.

## ◆ DynamicBiasStdDev()

 double sdf::v9::Noise::DynamicBiasStdDev ( ) const

For type "gaussian*", get the standard deviation of the noise used to drive a process to model slow variations in a sensor bias.

Returns
The dynamic bias standard deviation.

## ◆ Element()

 sdf::ElementPtr sdf::v9::Noise::Element ( ) const

Get a pointer to the SDF element that was used during load.

Returns
SDF element pointer. The value will be nullptr if Load has not been called.

 Errors sdf::v9::Noise::Load ( ElementPtr _sdf )

Load the noise based on a element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters
 [in] _sdf The SDF Element pointer
Returns
Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

## ◆ Mean()

 double sdf::v9::Noise::Mean ( ) const

Get the mean of the Gaussian distribution from which noise values are drawn.

This is applicable to "gaussian*" noise types.

Returns
The mean of the Guassian distribution.

## ◆ operator!=()

 bool sdf::v9::Noise::operator!= ( const Noise & _noise ) const

Return true the Noise objects do not contain the same values.

Parameters
 [_in] _noise Noise value to compare. \returen True if 'this' != _noise.

## ◆ operator=() [1/2]

 Noise& sdf::v9::Noise::operator= ( const Noise & _noise )

Assignment operator.

Parameters
 [in] _noise The noise to set values from.
Returns
*this

## ◆ operator=() [2/2]

 Noise& sdf::v9::Noise::operator= ( Noise && _noise )

Move assignment operator.

Parameters
 [in] _noise The noise to set values from.
Returns
*this

## ◆ operator==()

 bool sdf::v9::Noise::operator== ( const Noise & _noise ) const

Return true if both Noise objects contain the same values.

Parameters
 [_in] _noise Noise value to compare.
Returns
True if 'this' == _noise.

## ◆ Precision()

 double sdf::v9::Noise::Precision ( ) const

For type "gaussian_quantized", get the precision of output signals.

A value of zero implies infinite precision / no quantization.

Returns
Precision of output signals.

## ◆ SetBiasMean()

 void sdf::v9::Noise::SetBiasMean ( double _bias )

Set the mean of the Gaussian distribution from which bias values are drawn.

This is applicable to "gaussian*" noise types.

Parameters
 [in] _bias The mean of the bias Guassian distribution.

## ◆ SetBiasStdDev()

 void sdf::v9::Noise::SetBiasStdDev ( double _bias )

Set the standard deviation of the Gaussian distribution from which bias values are drawn.

This is applicable to "gaussian*" noise types.

Parameters
 [in] _bias The standard deviation of the bias Guassian distribution.

## ◆ SetDynamicBiasCorrelationTime()

 void sdf::v9::Noise::SetDynamicBiasCorrelationTime ( double _time )

For type "gaussian*", set the correlation time in seconds of the noise used to drive a process to model slow variations in a sensor bias.A typical value, when used, would be on the order of 3600 seconds (1 hour).

Parameters
 [in] _time The dynamic bias correlation time.

## ◆ SetDynamicBiasStdDev()

 void sdf::v9::Noise::SetDynamicBiasStdDev ( double _stddev )

For type "gaussian*", set the standard deviation of the noise used to drive a process to model slow variations in a sensor bias.

Parameters
 [in] _stddev The dynamic bias standard deviation.

## ◆ SetMean()

 void sdf::v9::Noise::SetMean ( double _mean )

Set the mean of the Gaussian distribution from which noise values are drawn.

This is applicable to "gaussian*" noise types.

Parameters
 [in] _mean The mean of the Guassian distribution.

## ◆ SetPrecision()

 void sdf::v9::Noise::SetPrecision ( double _precision )

For type "gaussian_quantized", set the precision of output signals.

A value of zero implies infinite precision / no quantization.

Parameters
 [in] _precision Precision of output signals.

## ◆ SetStdDev()

 void sdf::v9::Noise::SetStdDev ( double _stddev )

Set the standard deviation of the Gaussian distribution from which noise values are drawn.

This is applicable to "gaussian*" noise types.

Parameters
 [in] _stddev The standard deviation of the Guassian distribution.

## ◆ SetType()

 void sdf::v9::Noise::SetType ( NoiseType _type )

Set the type of noise.

Parameters
 [in] _type The noise type.

## ◆ StdDev()

 double sdf::v9::Noise::StdDev ( ) const

Get the standard deviation of the Gaussian distribution from which noise values are drawn.

This is applicable to "gaussian*" noise types.

Returns
The standard deviation of the Guassian distribution.

## ◆ Type()

 NoiseType sdf::v9::Noise::Type ( ) const

Get the type of noise.

Returns
The noise type.

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