casacore::GNoiseParam< T > Class Template Reference

A one dimensional normal distribution. More...

#include <GNoiseParam.h>

Inheritance diagram for casacore::GNoiseParam< T >:

Public Member Functions
	GNoiseParam ()
	Constructs the GNoise, Defaults: mean=0, var=1.0. More...
	GNoiseParam (const Double &mean, const Double &var)
	GNoiseParam (const GNoiseParam< T > &other)
	Copy constructor (deep copy) More...
GNoiseParam< T > &	operator= (const GNoiseParam< T > &other)
	Copy assignment (deep copy) More...
virtual	~GNoiseParam ()
	Destructor. More...
virtual uInt	ndim () const
	Returns the number of dimensions of function. More...
virtual const String &	name () const
	Give name of function. More...
Public Member Functions inherited from casacore::Function< T >
	Function ()
	Constructors. More...
	Function (const uInt n)
	Function (const Vector< T > &in)
	Function (const FunctionParam< T > &other)
	Function (const Function< W, X > &other)
	Function (const Function< T, U > &other)
virtual	~Function ()
	Destructor. More...
uInt	nparameters () const
	Returns the number of parameters. More...
virtual U	eval (FunctionArg x) const =0
	Evaluate the function object. More...
T &	operator[] (const uInt n)
	Manipulate the nth parameter (0-based) with no index check. More...
const T &	operator[] (const uInt n) const
virtual U	operator() () const
	Evaluate this function object at xor at x, y. More...
virtual U	operator() (const ArgType &x) const
virtual U	operator() (const Vector< ArgType > &x) const
virtual U	operator() (FunctionArg x) const
virtual U	operator() (const ArgType &x, const ArgType &y) const
virtual U	operator() (const ArgType &x, const ArgType &y, const ArgType &z) const
Bool &	mask (const uInt n)
	Manipulate the mask associated with the nth parameter (e.g. More...
const Bool &	mask (const uInt n) const
const FunctionParam< T > &	parameters () const
	Return the parameter interface. More...
FunctionParam< T > &	parameters ()
const Vector< ArgType > &	argp () const
	Get arg_p and parset_p. More...
Bool	parsetp () const
void	lockParam ()
	Compiler cannot always find the correct 'const' version of parameter access. More...
void	unlockParam ()
virtual void	setMode (const RecordInterface &mode)
	get/set the function mode. More...
virtual void	getMode (RecordInterface &mode) const
virtual Bool	hasMode () const
	return True if the implementing function supports a mode. More...
ostream &	print (ostream &os) const
	Print the function (i.e. More...
virtual Function< T, U > *	clone () const =0
	Return a copy of this object from the heap. More...
virtual Function< typename FunctionTraits< T >::DiffType > *	cloneAD () const
virtual Function< typename FunctionTraits< T >::BaseType > *	cloneNonAD () const
Public Member Functions inherited from casacore::Functional< FunctionTraits< T >::ArgType, U >
virtual	~Functional ()
	Destructor. More...
virtual U	operator() (const FunctionTraits< T >::ArgType &x) const =0
	Map a Domain x into a Range y value. More...
Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< T >::ArgType >, U >
virtual	~Functional ()
	Destructor. More...
virtual U	operator() (const Vector< FunctionTraits< T >::ArgType > &x) const =0
	Map a Domain x into a Range y value. More...

Protected Attributes
ACG	genit_p
	Random generator. More...
Normal	noise_p
	Normal noise. More...
Protected Attributes inherited from casacore::Function< T >
FunctionParam< T >	param_p
	The parameters and masks. More...
Vector< ArgType >	arg_p
	Aid for non-contiguous argument storage. More...
Bool	parset_p
	Indicate parameter written. More...
Bool	locked_p
	Indicate that parameters are expected to be locked from changing. More...

Additional Inherited Members
Public Types inherited from casacore::Function< T >
typedef FunctionTraits< T > ::ArgType	ArgType
typedef const ArgType *	FunctionArg

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

inlinevirtual

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

inlinevirtual

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)

Referenced by casacore::GNoiseFunction< T >::operator=().

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

mutableprotected

Normal noise.

Definition at line 117 of file GNoiseParam.h.

---

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

• casa/casacore/scimath/Functionals/GNoiseParam.h