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...  
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...  
Noise &  operator= (const Noise &_noise) 
Assignment operator. More...  
Noise &  operator= (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...  
The Noise class contains information about a noise model, such as a Gaussian distribution.
A Noise DOM object is typically available from a Sensor.
sdf::v9::Noise::Noise  (  ) 
Default constructor.

noexcept 
Move constructor.
[in]  _noise  Noise to move. 
sdf::v9::Noise::~Noise  (  ) 
Destructor.
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.
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.
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.
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.
sdf::ElementPtr sdf::v9::Noise::Element  (  )  const 
Errors sdf::v9::Noise::Load  (  ElementPtr  _sdf  ) 
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.
bool sdf::v9::Noise::operator!=  (  const Noise &  _noise  )  const 
Return true the Noise objects do not contain the same values.
Assignment operator.
[in]  _noise  The noise to set values from. 
Move assignment operator.
[in]  _noise  The noise to set values from. 
bool sdf::v9::Noise::operator==  (  const Noise &  _noise  )  const 
Return true if both Noise objects contain the same values.
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.
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.
[in]  _bias  The mean of the bias Guassian distribution. 
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.
[in]  _bias  The standard deviation of the bias Guassian distribution. 
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).
[in]  _time  The dynamic bias correlation time. 
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.
[in]  _stddev  The dynamic bias standard deviation. 
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.
[in]  _mean  The mean of the Guassian distribution. 
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.
[in]  _precision  Precision of output signals. 
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.
[in]  _stddev  The standard deviation of the Guassian distribution. 
void sdf::v9::Noise::SetType  (  NoiseType  _type  ) 
Set the type of noise.
[in]  _type  The noise type. 
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.
NoiseType sdf::v9::Noise::Type  (  )  const 
Get the type of noise.