Ignition Sensors

API Reference

ImageGaussianNoiseModel Class Reference

Gaussian noise class for image sensors. More...

#include <ignition/sensors/GaussianNoiseModel.hh>

Public Member Functions

 ImageGaussianNoiseModel ()
 Constructor. More...
virtual ~ImageGaussianNoiseModel ()
 Destructor. More...
virtual void Load (const sdf::Noise &_sdf) override
 Load noise parameters from sdf. More...
virtual void Print (std::ostream &_out) const override
 Documentation inherited. More...
virtual void SetCamera (rendering::CameraPtr _camera)
- Public Member Functions inherited from GaussianNoiseModel
 GaussianNoiseModel ()
 Constructor. More...
virtual ~GaussianNoiseModel ()
 Destructor. More...
double ApplyImpl (double _in, double _dt) override
 Apply noise to input data value. This gets overriden by derived classes, and called by Apply. More...
double Bias () const
 Accessor for bias. More...
double Mean () const
 Accessor for mean. More...
double StdDev () const
 Accessor for stddev. More...
- Public Member Functions inherited from Noise
 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 void SetCustomNoiseCallback (std::function< double(double, double)> _cb)
 Register a custom noise callback. More...
NoiseType Type () const
 Accessor for NoiseType. More...

Detailed Description

Gaussian noise class for image sensors.

Constructor & Destructor Documentation

◆ ImageGaussianNoiseModel()


◆ ~ImageGaussianNoiseModel()

virtual ~ImageGaussianNoiseModel ( )


Member Function Documentation

◆ Load()

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

Load noise parameters from sdf.

[in]_sdfSDF Noise DOM object.

Reimplemented from GaussianNoiseModel.

◆ Print()

virtual void Print ( std::ostream _out) const

Documentation inherited.

Reimplemented from GaussianNoiseModel.

◆ SetCamera()

virtual void SetCamera ( rendering::CameraPtr  _camera)

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