Gazebo Sensors

API Reference

9.0.0
List of all members | Public Member Functions
Noise Class Reference

Noise models for sensor output signals. More...

#include <gz/sensors/Noise.hh>

Public Member Functions

 Noise (NoiseType _type)
 Constructor. This should not be called directly unless creating an empty noise model. Use NoiseFactory::NewNoiseModel to instantiate a new noise model.
 
virtual ~Noise ()
 Destructor.
 
double Apply (double _in, double _dt=0.0)
 Apply noise to input data value.
 
virtual double ApplyImpl (double _in, double _dt)
 Apply noise to input data value. This gets overriden by derived classes, and called by Apply.
 
virtual void Load (const sdf::Noise &_sdf)
 Load noise parameters from sdf.
 
virtual void Print (std::ostream &_out) const
 Output information about the noise model.
 
virtual void SetCustomNoiseCallback (std::function< double(double, double)> _cb)
 Register a custom noise callback.
 
NoiseType Type () const
 Accessor for NoiseType.
 

Detailed Description

Noise models for sensor output signals.

Constructor & Destructor Documentation

◆ Noise()

Noise ( NoiseType  _type)
explicit

Constructor. This should not be called directly unless creating an empty noise model. Use NoiseFactory::NewNoiseModel to instantiate a new noise model.

Parameters
[in]_typeType of noise model.
See also
NoiseFactory::NewNoiseModel

◆ ~Noise()

virtual ~Noise ( )
virtual

Destructor.

Member Function Documentation

◆ Apply()

double Apply ( double  _in,
double  _dt = 0.0 
)

Apply noise to input data value.

Parameters
[in]_inInput data value.
[in]_dtInput data time step.
Returns
Data with noise applied.

◆ ApplyImpl()

virtual double ApplyImpl ( double  _in,
double  _dt 
)
virtual

Apply noise to input data value. This gets overriden by derived classes, and called by Apply.

Parameters
[in]_inInput data value.
[in]_dtInput data time step.
Returns
Data with noise applied.

Reimplemented in GaussianNoiseModel.

◆ Load()

virtual void Load ( const sdf::Noise &  _sdf)
virtual

Load noise parameters from sdf.

Parameters
[in]_sdfSDF Noise DOM object.

Reimplemented in GaussianNoiseModel, and ImageGaussianNoiseModel.

◆ Print()

virtual void Print ( std::ostream &  _out) const
virtual

Output information about the noise model.

Parameters
[in]_outOutput stream

Reimplemented in GaussianNoiseModel, and ImageGaussianNoiseModel.

◆ SetCustomNoiseCallback()

virtual void SetCustomNoiseCallback ( std::function< double(double, double)>  _cb)
virtual

Register a custom noise callback.

Parameters
[in]_cbCallback function for applying a custom noise model. This is useful if users want to use their own noise model from a sensor plugin.

◆ Type()

NoiseType Type ( ) const

Accessor for NoiseType.

Returns
Type of noise currently in use.
The documentation for this class was generated from the following file: