casacore::GNoiseParam< T > Class Template Reference

A one dimensional normal distribution. More...

#include <GNoiseParam.h>

Inheritance diagram for casacore::GNoiseParam< T >:

List of all members.

Public Member Functions
	GNoiseParam ()
	Constructs the GNoise, Defaults: mean=0, var=1.0.
	GNoiseParam (const Double &mean, const Double &var)
	GNoiseParam (const GNoiseParam< T > &other)
	Copy constructor (deep copy).
GNoiseParam< T > &	operator= (const GNoiseParam< T > &other)
	Copy assignment (deep copy).
virtual	~GNoiseParam ()
	Destructor.
virtual uInt	ndim () const
	Returns the number of dimensions of function.
virtual const String &	name () const
	Give name of function.
Protected Attributes
ACG	genit_p
	Random generator.
Normal	noise_p
	Normal noise.

---

Detailed Description

template<class T>
class casacore::GNoiseParam< T >

A one dimensional normal distribution.

Intended use:

Internal

Review Status

Test programs:

tFunctionHolder

Prerequisite

• FunctionParam class
• Function class

Etymology

Gaussian Noise generator.

Synopsis

A GNoise is described by a mean and a variance (Note these are not parameters in the Function sense, but more like the order of a polynomial. The defaults are 0 and 1.

Example

 GNoiseFunction<Double> sf;
 sf();            // = 0.12

Template Type Argument Requirements (T)

• T should have standard numerical operators

Thrown Exceptions

• AipsError if incorrect parameter number specified.

Definition at line 80 of file GNoiseParam.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::GNoiseParam< T >::GNoiseParam

(

)

Constructs the GNoise, Defaults: mean=0, var=1.0.

template<class T>

casacore::GNoiseParam< T >::GNoiseParam	(	const Double &	mean,
		const Double &	var
	)

template<class T>

casacore::GNoiseParam< T >::GNoiseParam

(

const GNoiseParam< T > &

other

)

Copy constructor (deep copy).

template<class T>

virtual casacore::GNoiseParam< T >::~GNoiseParam

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<class T>

virtual const String& casacore::GNoiseParam< T >::name

(

)

const [inline, virtual]

Give name of function.

Reimplemented from casacore::Function< T >.

Definition at line 109 of file GNoiseParam.h.

template<class T>

virtual uInt casacore::GNoiseParam< T >::ndim

(

)

const [inline, virtual]

Returns the number of dimensions of function.

Implements casacore::Function< T >.

Definition at line 105 of file GNoiseParam.h.

template<class T>

GNoiseParam<T>& casacore::GNoiseParam< T >::operator=

(

const GNoiseParam< T > &

other

)

Copy assignment (deep copy).

Reimplemented in casacore::GNoiseFunction< T >.

---

Member Data Documentation

template<class T>

ACG casacore::GNoiseParam< T >::genit_p [protected]

Random generator.

Definition at line 115 of file GNoiseParam.h.

template<class T>

Normal casacore::GNoiseParam< T >::noise_p [mutable, protected]

Normal noise.

Definition at line 117 of file GNoiseParam.h.

---

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

• casacore/scimath/Functionals/GNoiseParam.h