casacore::GNoiseFunction< T > Class Template Reference

More...

#include <GNoiseFunction.h>

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.
Public Member Functions inherited from casacore::GNoiseParam< T >
	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.
Public Member Functions inherited from casacore::Function< T, U >
	Function ()
	Constructors.
	Function (const uInt n)
	Function (const Vector< T > &in)
	Function (const FunctionParam< T > &other)
template<class W , class X >
	Function (const Function< W, X > &other)
virtual	~Function ()
	Destructor.
uInt	nparameters () const
	Returns the number of parameters.
virtual U	eval (FunctionArg x) const =0
	Evaluate the function object.
T &	operator[] (const uInt n)
	Manipulate the nth parameter (0-based) with no index check.
const T &	operator[] (const uInt n) const
virtual U	operator() () const
	Evaluate this function object at xor at x, y.
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.
const Bool &	mask (const uInt n) const
const FunctionParam< T > &	parameters () const
	Return the parameter interface.
FunctionParam< T > &	parameters ()
const Vector< ArgType > &	argp () const
	Get arg_p and parset_p.
Bool	parsetp () const
void	lockParam ()
	Compiler cannot always find the correct 'const' version of parameter access.
void	unlockParam ()
virtual void	setMode (const RecordInterface &mode)
	get/set the function mode.
virtual void	getMode (RecordInterface &mode) const
virtual Bool	hasMode () const
	return True if the implementing function supports a mode.
ostream &	print (ostream &os) const
	Print the function (i.e.
virtual Function< typename FunctionTraits< T >::DiffType > *	cloneAD () const
virtual Function< typename FunctionTraits< T >::BaseType > *	cloneNonAD () const
Public Member Functions inherited from casacore::Functional< Domain, Range >
virtual	~Functional ()
	Destructor.
virtual Range	operator() (const Domain &x) const =0
	Map a Domain x into a Range y value.

Additional Inherited Members
Public Types inherited from casacore::Function< T, U >
typedef FunctionTraits< T >::ArgType	ArgType
typedef const ArgType *	FunctionArg
Protected Attributes inherited from casacore::GNoiseParam< T >
ACG	genit_p
	Random generator.
Normal	noise_p
	Normal noise.
Protected Attributes inherited from casacore::Function< T, U >
FunctionParam< T >	param_p
	The parameters and masks.
Vector< ArgType >	arg_p
	Aid for non-contiguous argument storage.
Bool	parset_p
	Indicate parameter written.
Bool	locked_p
	Indicate that parameters are expected to be locked from changing.

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 78 of file GNoiseFunction.h.

Constructor & Destructor Documentation

GNoiseFunction() [1/4]

template<class T >

casacore::GNoiseFunction< T >::GNoiseFunction ( )

inline

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

Definition at line 85 of file GNoiseFunction.h.

GNoiseFunction() [2/4]

template<class T >

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

inline

Definition at line 86 of file GNoiseFunction.h.

GNoiseFunction() [3/4]

template<class T >

casacore::GNoiseFunction< T >::GNoiseFunction ( const GNoiseFunction< T > &  other )

inline

Copy constructor (deep copy)

Definition at line 92 of file GNoiseFunction.h.

GNoiseFunction() [4/4]

template<class T >

template<class W >

casacore::GNoiseFunction< T >::GNoiseFunction ( const GNoiseFunction< W > &  other )

inline

Definition at line 94 of file GNoiseFunction.h.

~GNoiseFunction()

template<class T >

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

inlinevirtual

Destructor.

Definition at line 102 of file GNoiseFunction.h.

Member Function Documentation

clone()

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, U >.

Definition at line 115 of file GNoiseFunction.h.

eval()

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.

operator=()

template<class T >

GNoiseFunction< T > & casacore::GNoiseFunction< T >::operator= ( const GNoiseFunction< T > &  other )

inline

Copy assignment (deep copy)

Definition at line 98 of file GNoiseFunction.h.

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

---

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

• scimath/Functionals/GNoiseFunction.h