ImageGaussianNoiseModel Class Reference

#include <GaussianNoiseModel.hh>

Inherits GaussianNoiseModel.

Public Types

enum  NoiseType { NONE, CUSTOM, GAUSSIAN }
 Which noise types we support. More...
 

Public Member Functions

 ImageGaussianNoiseModel ()
 Constructor. More...
 
virtual ~ImageGaussianNoiseModel ()
 Destructor. More...
 
double Apply (double _in)
 Apply noise to input data value. More...
 
double ApplyImpl (double _in)
 Apply noise to input data value. More...
 
virtual void Fini ()
 Finalize the noise model. More...
 
double GetBias () const
 Accessor for bias. More...
 
double GetMean () const
 Accessor for mean. More...
 
NoiseType GetNoiseType () const
 Accessor for NoiseType. More...
 
double GetStdDev () const
 Accessor for stddev. More...
 
virtual void Load (sdf::ElementPtr _sdf)
 Load noise parameters from sdf. More...
 
virtual void Print (std::ostream &_out) const
 Documentation inherited. More...
 
virtual void SetCamera (rendering::CameraPtr _camera)
 Set camera needed to create image noise. More...
 
virtual void SetCustomNoiseCallback (boost::function< double(double)> _cb)
 Register a custom noise callback. More...
 

Public Attributes

boost::shared_ptr< GaussianNoiseCompositorListener > gaussianNoiseCompositorListener
 Gaussian noise compositor listener. More...
 
Ogre::CompositorInstance * gaussianNoiseInstance
 Gaussian noise compositor. More...
 

Protected Attributes

double bias
 If type starts with GAUSSIAN, the bias we'll add. More...
 
double mean
 If type starts with GAUSSIAN, the mean of the distribution from which we sample when adding noise. More...
 
double precision
 If type==GAUSSIAN_QUANTIZED, the precision to which the output signal is rounded. More...
 
bool quantized
 True if the type is GAUSSIAN_QUANTIZED. More...
 
double stdDev
 If type starts with GAUSSIAN, the standard deviation of the distribution from which we sample when adding noise. More...
 

Member Enumeration Documentation

enum NoiseType
inherited

Which noise types we support.

Enumerator
NONE 
CUSTOM 
GAUSSIAN 

Constructor & Destructor Documentation

Constructor.

virtual ~ImageGaussianNoiseModel ( )
virtual

Destructor.

Member Function Documentation

double Apply ( double  _in)
inherited

Apply noise to input data value.

Parameters
[in]_inInput data value.
Returns
Data with noise applied.
double ApplyImpl ( double  _in)
virtualinherited

Apply noise to input data value.

This gets overriden by derived classes, and called by Apply.

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

Reimplemented from Noise.

virtual void Fini ( )
virtual

Finalize the noise model.

Reimplemented from GaussianNoiseModel.

double GetBias ( ) const
inherited

Accessor for bias.

Returns
Bias on output.
double GetMean ( ) const
inherited

Accessor for mean.

Returns
Mean of Gaussian noise.
NoiseType GetNoiseType ( ) const
inherited

Accessor for NoiseType.

Returns
Type of noise currently in use.
double GetStdDev ( ) const
inherited

Accessor for stddev.

Returns
Standard deviation of Gaussian noise.
virtual void Load ( sdf::ElementPtr  _sdf)
virtual

Load noise parameters from sdf.

Parameters
[in]_sdfSDF parameters.
[in]_sensorType of sensor.

Reimplemented from GaussianNoiseModel.

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

Documentation inherited.

Reimplemented from GaussianNoiseModel.

virtual void SetCamera ( rendering::CameraPtr  _camera)
virtual

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]_cameraCamera associated to an image sensor

Reimplemented from Noise.

virtual void SetCustomNoiseCallback ( boost::function< double(double)>  _cb)
virtualinherited

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.

Member Data Documentation

double bias
protectedinherited

If type starts with GAUSSIAN, the bias we'll add.

boost::shared_ptr<GaussianNoiseCompositorListener> gaussianNoiseCompositorListener

Gaussian noise compositor listener.

Ogre::CompositorInstance* gaussianNoiseInstance

Gaussian noise compositor.

double mean
protectedinherited

If type starts with GAUSSIAN, the mean of the distribution from which we sample when adding noise.

double precision
protectedinherited

If type==GAUSSIAN_QUANTIZED, the precision to which the output signal is rounded.

bool quantized
protectedinherited

True if the type is GAUSSIAN_QUANTIZED.

double stdDev
protectedinherited

If type starts with GAUSSIAN, the standard deviation of the distribution from which we sample when adding noise.


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