All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
gazebo::sensors::Noise Class Reference

Noise models for sensor output signals. More...

#include <sensors/sensors.hh>

Public Types

enum  NoiseType { NONE, GAUSSIAN, GAUSSIAN_QUANTIZED }
 Which noise types we support. More...
 

Public Member Functions

 Noise ()
 Constructor. More...
 
 ~Noise ()
 Destructor. More...
 
double Apply (double _in) const
 Apply noise to input data value. More...
 
double GetBias () const
 Accessor for bias. More...
 
double GetMean () const
 Accessor for mean. More...
 
NoiseType GetNoiseType () const
 Accessor for NoiseType. More...
 
double GetStdDev () const
 Accessor for stddev. More...
 
void Load (sdf::ElementPtr _sdf)
 Load parameters from sdf. More...
 

Detailed Description

Noise models for sensor output signals.

Member Enumeration Documentation

Which noise types we support.

Enumerator
NONE 
GAUSSIAN 
GAUSSIAN_QUANTIZED 

Constructor & Destructor Documentation

gazebo::sensors::Noise::Noise ( )

Constructor.

gazebo::sensors::Noise::~Noise ( )

Destructor.

Member Function Documentation

double gazebo::sensors::Noise::Apply ( double  _in) const

Apply noise to input data value.

Parameters
[in]_inInput data value.
Returns
Data with noise applied.
double gazebo::sensors::Noise::GetBias ( ) const

Accessor for bias.

Returns
Bias on output.
double gazebo::sensors::Noise::GetMean ( ) const

Accessor for mean.

Returns
Mean of Gaussian noise.
NoiseType gazebo::sensors::Noise::GetNoiseType ( ) const

Accessor for NoiseType.

Returns
Type of noise currently in use.
double gazebo::sensors::Noise::GetStdDev ( ) const

Accessor for stddev.

Returns
Standard deviation of Gaussian noise.
void gazebo::sensors::Noise::Load ( sdf::ElementPtr  _sdf)

Load parameters from sdf.

Parameters
[in]_sdfSDF parameters.

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