BaseGaussianNoisePass< T > Class Template Reference

Base Gaussian noise render pass. More...

#include <BaseGaussianNoisePass.hh>

Public Member Functions
virtual	~BaseGaussianNoisePass ()
	Destructor.
double	Bias () const
	Accessor for bias.
double	Mean () const
	Accessor for mean.
void	SetBiasMean (double _biasMean)
	Set the mean of the bias value. Bias is computed based on the bias mean and bias standard deviation.
void	SetBiasStdDev (double _biasStdDev)
	Set the standard deviation of the bias value. Bias is computed based on the bias mean and bias standard deviation.
void	SetMean (double _mean)
	Set mean.
void	SetStdDev (double _stdDev)
	Set stddev.
double	StdDev () const
	Accessor for stddev.
Public Member Functions inherited from GaussianNoisePass
	GaussianNoisePass ()
	Constructor.
virtual	~GaussianNoisePass ()
	Destructor.
Public Member Functions inherited from RenderPass
virtual	~RenderPass ()
	Destructor.
virtual bool	IsEnabled () const =0
	Get whether or not the render pass is enabled.
virtual void	PreRender (const CameraPtr &_camera)=0
	See Object::PreRender. This function will call Object::PreRender but with the added bonus that it has access to the camera that is about to render.
virtual void	SetEnabled (bool _enabled)=0
	Set to enable or disable the render pass.
virtual void	SetWideAngleCameraAfterStitching (bool _afterStitching)=0
	WideAngleCamera renders to 6 faces; then stitches all 6 into a final "fish-eye" lens result.
virtual bool	WideAngleCameraAfterStitching () const =0
	See SetWideAngleCameraAfterStitching()
Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.
virtual void	Destroy ()=0
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
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.
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.
virtual void	PostRender ()=0
	Post process this object and any of its children after rendering.
virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.

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

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

Detailed Description

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

Base Gaussian noise render pass.

Constructor & Destructor Documentation

BaseGaussianNoisePass()

template<class T >

BaseGaussianNoisePass ( )

protected

Constructor.

~BaseGaussianNoisePass()

template<class T >

~BaseGaussianNoisePass ( )

virtual

Destructor.

Member Function Documentation

Bias()

template<class T >

double Bias ( ) const

virtual

Accessor for bias.

Returns

Bias on output.

Implements GaussianNoisePass.

Mean()

template<class T >

double Mean ( ) const

virtual

Accessor for mean.

Returns

Mean of Gaussian noise.

Implements GaussianNoisePass.

SampleBias()

template<class T >

void SampleBias ( )

protected

References Rand::DblNormal(), and Rand::DblUniform().

SetBiasMean()

template<class T >

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()

template<class T >

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()

template<class T >

void SetMean ( double  _mean )

virtual

Set mean.

Parameters

[in]

_mean

Mean of Gaussian noise.

Implements GaussianNoisePass.

SetStdDev()

template<class T >

void SetStdDev ( double  _stdDev )

virtual

Set stddev.

Parameters

[in]

_stdDev

Standard deviation of Gaussian noise.

Implements GaussianNoisePass.

StdDev()

template<class T >

double StdDev ( ) const

virtual

Accessor for stddev.

Returns

Standard deviation of Gaussian noise.

Implements GaussianNoisePass.

Member Data Documentation

bias

template<class T >

double bias = 0.0

protected

Gaussian noise bias.

biasMean

template<class T >

double biasMean = 0

protected

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

biasStdDev

template<class T >

double biasStdDev = 0

protected

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

mean

template<class T >

double mean = 0.0

protected

Gaussian noise mean.

stdDev

template<class T >

double stdDev = 0.0

protected

Standard deviation of Gaussian noise.

---

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

• BaseGaussianNoisePass.hh