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...

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...

Errors	Load (ElementPtr _sdf)
	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...

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...

sdf::ElementPtr	ToElement () const
	Create and return an SDF element filled with data from this noise. More...

sdf::ElementPtr	ToElement (sdf::Errors &_errors) const
	Create and return an SDF element filled with data from this noise. 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.

Constructor & Destructor Documentation

◆ Noise()

sdf::SDF_VERSION_NAMESPACE::Noise::Noise ( )

Default constructor.

Member Function Documentation

◆ BiasMean()

double sdf::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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.

◆ Load()

Errors sdf::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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==()

bool sdf::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::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::SDF_VERSION_NAMESPACE::Noise::SetType ( NoiseType _type )

Set the type of noise.

Parameters

[in] _type The noise type.

◆ StdDev()

double sdf::SDF_VERSION_NAMESPACE::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.

◆ ToElement() [1/2]

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Noise::ToElement ( ) const

Create and return an SDF element filled with data from this noise.

Note that parameter passing functionality is not captured with this function.

Returns: SDF element pointer with updated noise values.

◆ ToElement() [2/2]

sdf::ElementPtr sdf::SDF_VERSION_NAMESPACE::Noise::ToElement ( sdf::Errors & _errors ) const

Create and return an SDF element filled with data from this noise.

Note that parameter passing functionality is not captured with this function.

Parameters

[out] _errors Vector of errors.

Returns: SDF element pointer with updated noise values.

◆ Type()

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

Get the type of noise.

Returns: The noise type.

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

Noise.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Noise()

Member Function Documentation

◆ BiasMean()

◆ BiasStdDev()

◆ DynamicBiasCorrelationTime()

◆ DynamicBiasStdDev()

◆ Element()

◆ Load()

◆ Mean()

◆ operator!=()

◆ operator==()

◆ Precision()

◆ SetBiasMean()

◆ SetBiasStdDev()

◆ SetDynamicBiasCorrelationTime()

◆ SetDynamicBiasStdDev()

◆ SetMean()

◆ SetPrecision()

◆ SetStdDev()

◆ SetType()

◆ StdDev()

◆ ToElement() [1/2]

◆ ToElement() [2/2]

◆ Type()