casacore::GNoiseFunction< T > Class Template Reference

A one dimensional normal distribution. More...

#include <GNoiseFunction.h>

Inheritance diagram for casacore::GNoiseFunction< T >:

List of all members.

Public Member Functions
	GNoiseFunction ()
	Constructs the GNoise, Defaults: mean=0, var=1.0.
	GNoiseFunction (const Double &mean, const Double &var)
	GNoiseFunction (const GNoiseFunction< T > &other)
	Copy constructor (deep copy).
template<class W >
	GNoiseFunction (const GNoiseFunction< W > &other)
GNoiseFunction< T > &	operator= (const GNoiseFunction< T > &other)
	Copy assignment (deep copy).
virtual	~GNoiseFunction ()
	Destructor.
virtual T	eval (typename Function< T >::FunctionArg x) const
	Evaluate the GNoise at x.
virtual Function< T > *	clone () const
	Return a copy of this object from the heap.

---

Detailed Description

template<class T>
class casacore::GNoiseFunction< T >

A one dimensional normal distribution.

Intended use:

Public interface

Review Status

Test programs:

tFunctionHolder

Prerequisite

• GNoiseParam
• Function

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 GNoiseFunction.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::GNoiseFunction< T >::GNoiseFunction

(

)

[inline]

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

Definition at line 87 of file GNoiseFunction.h.

template<class T>

casacore::GNoiseFunction< T >::GNoiseFunction	(	const Double &	mean,
		const Double &	var
	)			[inline]

Definition at line 88 of file GNoiseFunction.h.

template<class T>

casacore::GNoiseFunction< T >::GNoiseFunction

(

const GNoiseFunction< T > &

other

)

[inline]

Copy constructor (deep copy).

Definition at line 94 of file GNoiseFunction.h.

template<class T>

template<class W >

casacore::GNoiseFunction< T >::GNoiseFunction

(

const GNoiseFunction< W > &

other

)

[inline]

Definition at line 96 of file GNoiseFunction.h.

template<class T>

virtual casacore::GNoiseFunction< T >::~GNoiseFunction

(

)

[inline, virtual]

Destructor.

Definition at line 104 of file GNoiseFunction.h.

---

Member Function Documentation

template<class T>

virtual Function<T>* casacore::GNoiseFunction< T >::clone

(

)

const [inline, virtual]

Return a copy of this object from the heap.

The caller is responsible for deleting this pointer.

Implements casacore::Function< T >.

Definition at line 117 of file GNoiseFunction.h.

template<class T>

virtual T casacore::GNoiseFunction< T >::eval

(

typename Function< T >::FunctionArg

x

)

const [virtual]

Evaluate the GNoise at x.

If a vector is used as the argument only its first element is used.

template<class T>

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

(

const GNoiseFunction< T > &

other

)

[inline]

Copy assignment (deep copy).

Reimplemented from casacore::GNoiseParam< T >.

Definition at line 100 of file GNoiseFunction.h.

---

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

• casacore/scimath/Functionals/GNoiseFunction.h