GaussianNoiseModel Class Reference

Gaussian noise class. More...

#include <gz/sensors/GaussianNoiseModel.hh>

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

Detailed Description

Gaussian noise class.

Constructor & Destructor Documentation

GaussianNoiseModel()

GaussianNoiseModel

(

)

Constructor.

~GaussianNoiseModel()

virtual ~GaussianNoiseModel ( )

virtual

Destructor.

Member Function Documentation

ApplyImpl()

double ApplyImpl ( double  _in, double  _dt  )

overridevirtual

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 from Noise.

Bias()

double Bias

(

)

const

Accessor for bias.

Returns

Bias on output.

Load()

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

overridevirtual

Load noise parameters from sdf.

Parameters

[in]

_sdf

SDF Noise DOM object.

Reimplemented from Noise.

Reimplemented in ImageGaussianNoiseModel.

Mean()

double Mean

(

)

const

Accessor for mean.

Returns

Mean of Gaussian noise.

Print()

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

overridevirtual

Documentation inherited.

Reimplemented from Noise.

Reimplemented in ImageGaussianNoiseModel.

StdDev()

double StdDev

(

)

const

Accessor for stddev.

Returns

Standard deviation of Gaussian noise.

---

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

• GaussianNoiseModel.hh