A one dimensional normal distribution. More...

#include <GNoiseFunction.h>

Inheritance diagram for casacore::GNoiseFunction< T >:

Public Member Functions
	GNoiseFunction ()
	Constructs the GNoise, Defaults: mean=0, var=1.0. More...

	GNoiseFunction (const Double &mean, const Double &var)

	GNoiseFunction (const GNoiseFunction< T > &other)
	Copy constructor (deep copy) More...

template<class W >
	GNoiseFunction (const GNoiseFunction< W > &other)

GNoiseFunction< T > &	operator= (const GNoiseFunction< T > &other)
	Copy assignment (deep copy) More...

virtual	~GNoiseFunction ()
	Destructor. More...

virtual T	eval (typename Function< T >::FunctionArg x) const
	Evaluate the GNoise at `x`. More...

virtual Function< T > *	clone () const
	Return a copy of this object from the heap. More...

Public Member Functions inherited from casacore::GNoiseParam< T >
	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)

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 `x`or 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< 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...

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

typedef const ArgType *	FunctionArg

Protected Attributes inherited from casacore::GNoiseParam< T >
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...

Detailed Description

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

A one dimensional normal distribution.

Intended use:

Public interface

Review Status

Test programs:: tFunctionHolder

Prerequisite

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

inlinevirtual

Destructor.

Definition at line 104 of file GNoiseFunction.h.

Member Function Documentation

template<class T>

virtual Function<T>* casacore::GNoiseFunction< T >::clone ( ) const

inlinevirtual

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)

Definition at line 100 of file GNoiseFunction.h.

References casacore::GNoiseParam< T >::operator=().

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

scimath/Functionals/GNoiseFunction.h

Public Member Functions

Additional Inherited Members

Detailed Description

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

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Template Type Argument Requirements (T)

Thrown Exceptions

Constructor & Destructor Documentation

Member Function Documentation

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