BaseGaussianNoisePass< T > Class Template Reference

Base Gaussian noise render pass. More...

#include <BaseGaussianNoisePass.hh>

Public Member Functions
virtual	~BaseGaussianNoisePass ()
	Destructor. More...
double	Bias () const
	Accessor for bias. More...
double	Mean () const
	Accessor for mean. More...
void	SetBiasMean (double _biasMean)
	Set the mean of the bias value. Bias is computed based on the bias mean and bias standard deviation. More...
void	SetBiasStdDev (double _biasStdDev)
	Set the standard deviation of the bias value. Bias is computed based on the bias mean and bias standard deviation. More...
void	SetMean (double _mean)
	Set mean. More...
void	SetStdDev (double _stdDev)
	Set stddev. More...
double	StdDev () const
	Accessor for stddev. More...
Public Member Functions inherited from GaussianNoisePass
	GaussianNoisePass ()
	Constructor. More...
virtual	~GaussianNoisePass ()
	Destructor. More...
Public Member Functions inherited from RenderPass
virtual	~RenderPass ()
	Destructor. More...
virtual bool	IsEnabled () const =0
	Get whether or not the render pass is enabled. More...
virtual void	SetEnabled (bool _enabled)=0
	Set to enable or disable the render pass. More...
Public Member Functions inherited from Object
virtual	~Object ()
	Destructor. More...
virtual void	Destroy ()=0
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
virtual unsigned int	Id () const =0
	Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
virtual std::string	Name () const =0
	Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
virtual void	PostRender ()=0
	Post process this object and any of its children after rendering. More...
virtual void	PreRender ()=0
	Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...
virtual ScenePtr	Scene () const =0
	Get the Scene that created this object. More...

Protected Member Functions
	BaseGaussianNoisePass ()
	Constructor. More...
void	SampleBias ()

Protected Attributes
double	bias = 0.0
	Gaussian noise bias. More...
double	biasMean = 0
	The mean of the Gaussian distribution from which bias values are drawn. More...
double	biasStdDev = 0
	The standard deviation of the Gaussian distribution from which bias values are drawn. More...
double	mean = 0.0
	Gaussian noise mean. More...
double	stdDev = 0.0
	Standard deviation of Gaussian noise. More...

Detailed Description

template<class T>
class ignition::rendering::BaseGaussianNoisePass< T >

Base Gaussian noise render pass.

Constructor & Destructor Documentation

BaseGaussianNoisePass()

BaseGaussianNoisePass

protected

Constructor.

~BaseGaussianNoisePass()

~BaseGaussianNoisePass

virtual

Destructor.

Member Function Documentation

Bias()

double Bias ( ) const

virtual

Accessor for bias.

Returns

Bias on output.

Implements GaussianNoisePass.

Mean()

double Mean ( ) const

virtual

Accessor for mean.

Returns

Mean of Gaussian noise.

Implements GaussianNoisePass.

SampleBias()

void SampleBias

protected

SetBiasMean()

void SetBiasMean ( double  _biasMean )

virtual

Set the mean of the bias value. Bias is computed based on the bias mean and bias standard deviation.

See also

SetBiasStdDev

Implements GaussianNoisePass.

SetBiasStdDev()

void SetBiasStdDev ( double  _biasStdDev )

virtual

Set the standard deviation of the bias value. Bias is computed based on the bias mean and bias standard deviation.

See also

SetBiasMean

Implements GaussianNoisePass.

SetMean()

void SetMean ( double  _mean )

virtual

Set mean.

Parameters

[in]

_mean

Mean of Gaussian noise.

Implements GaussianNoisePass.

SetStdDev()

void SetStdDev ( double  _stdDev )

virtual

Set stddev.

Parameters

[in]

_stdDev

Standard deviation of Gaussian noise.

Implements GaussianNoisePass.

StdDev()

double StdDev ( ) const

virtual

Accessor for stddev.

Returns

Standard deviation of Gaussian noise.

Implements GaussianNoisePass.

Member Data Documentation

bias

double bias = 0.0

protected

Gaussian noise bias.

biasMean

double biasMean = 0

protected

The mean of the Gaussian distribution from which bias values are drawn.

biasStdDev

double biasStdDev = 0

protected

The standard deviation of the Gaussian distribution from which bias values are drawn.

mean

double mean = 0.0

protected

Gaussian noise mean.

stdDev

double stdDev = 0.0

protected

Standard deviation of Gaussian noise.

---

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

• gz/rendering/base/BaseGaussianNoisePass.hh