Noise models for sensor output signals.
More...
#include <Noise.hh>
Inherited by GaussianNoiseModel.
|
| Noise (NoiseType _type) |
| Constructor.
|
|
virtual | ~Noise () |
| Destructor.
|
|
double | Apply (double _in) |
| Apply noise to input data value.
|
|
virtual double | ApplyImpl (double _in) |
| Apply noise to input data value.
|
|
virtual void | Fini () |
| Finalize the noise model.
|
|
NoiseType | GetNoiseType () const |
| Accessor for NoiseType.
|
|
virtual void | Load (sdf::ElementPtr _sdf) |
| Load noise parameters from sdf.
|
|
virtual void | Print (std::ostream &_out) const |
| Output information about the noise model.
|
|
virtual void | SetCamera (rendering::CameraPtr _camera) |
| Set camera needed to create image noise.
|
|
virtual void | SetCustomNoiseCallback (boost::function< double(double)> _cb) |
| Register a custom noise callback.
|
|
Noise models for sensor output signals.
◆ NoiseType
Which noise types we support.
Enumerator |
---|
NONE | |
CUSTOM | |
GAUSSIAN | |
◆ Noise()
◆ ~Noise()
◆ Apply()
double Apply |
( |
double | _in | ) |
|
Apply noise to input data value.
- Parameters
-
- Returns
- Data with noise applied.
◆ ApplyImpl()
virtual double ApplyImpl |
( |
double | _in | ) |
|
|
virtual |
Apply noise to input data value.
This gets overriden by derived classes, and called by Apply.
- Parameters
-
- Returns
- Data with noise applied.
Reimplemented in GaussianNoiseModel.
◆ Fini()
◆ GetNoiseType()
Accessor for NoiseType.
- Returns
- Type of noise currently in use.
◆ Load()
virtual void Load |
( |
sdf::ElementPtr | _sdf | ) |
|
|
virtual |
◆ Print()
virtual void Print |
( |
std::ostream & | _out | ) |
const |
|
virtual |
◆ SetCamera()
Set camera needed to create image noise.
This is only needed for image sensors, i.e. camera/multicamera/depth sensors, which use shaders for more efficient noise generation.
- Parameters
-
[in] | _camera | Camera associated to an image sensor |
Reimplemented in ImageGaussianNoiseModel.
◆ SetCustomNoiseCallback()
virtual void SetCustomNoiseCallback |
( |
boost::function< double(double)> | _cb | ) |
|
|
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. |
The documentation for this class was generated from the following file: