GNoiseParam.h

Classes

GNoiseParam -- A one dimensional normal distribution (full description)

template<class T> class GNoiseParam : public Function<T>

Interface

Public Members

GNoiseParam()

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

GNoiseParam(const GNoiseParam<T> &other)

GNoiseParam<T> &operator=(const GNoiseParam<T> &other)

virtual ~GNoiseParam()

virtual uInt ndim() const

virtual const String &name() const

Description

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.

Member Description

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

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

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

virtual const String &name() const

Give name of function