Noise Class Reference
Noise models for sensor output signals. More...
#include <ignition/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. More... | |
| virtual | ~Noise () |
| Destructor. More... | |
| double | Apply (double _in, double _dt=0.0) |
| Apply noise to input data value. More... | |
| virtual double | ApplyImpl (double _in, double _dt) |
| Apply noise to input data value. This gets overriden by derived classes, and called by Apply. More... | |
| virtual void | Load (const sdf::Noise &_sdf) |
| Load noise parameters from sdf. More... | |
| virtual void | Print (std::ostream &_out) const |
| Output information about the noise model. More... | |
| virtual void | SetCustomNoiseCallback (std::function< double(double, double)> _cb) |
| Register a custom noise callback. More... | |
| NoiseType | Type () const |
| Accessor for NoiseType. More... | |
Detailed Description
Noise models for sensor output signals.
Constructor & Destructor Documentation
◆ Noise()
Constructor. This should not be called directly unless creating an empty noise model. Use NoiseFactory::NewNoiseModel to instantiate a new noise model.
- Parameters
-
[in] _type Type of noise model.
- See also
- NoiseFactory::NewNoiseModel
◆ ~Noise()
|
virtual |
Destructor.
Member Function Documentation
◆ Apply()
| double Apply | ( | double | _in, |
| double | _dt = 0.0 |
||
| ) |
Apply noise to input data value.
- Parameters
-
[in] _in Input data value. [in] _dt Input data time step.
- Returns
- Data with noise applied.
◆ ApplyImpl()
|
virtual |
Apply noise to input data value. This gets overriden by derived classes, and called by Apply.
- Parameters
-
[in] _in Input data value. [in] _dt Input data time step.
- Returns
- Data with noise applied.
Reimplemented in GaussianNoiseModel.
◆ Load()
|
virtual |
Load noise parameters from sdf.
- Parameters
-
[in] _sdf SDF Noise DOM object.
Reimplemented in ImageGaussianNoiseModel, and GaussianNoiseModel.
◆ Print()
|
virtual |
Output information about the noise model.
- Parameters
-
[in] _out Output stream
Reimplemented in GaussianNoiseModel, and ImageGaussianNoiseModel.
◆ SetCustomNoiseCallback()
|
virtual |
Register a custom noise callback.
- Parameters
-
[in] _cb Callback 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: