casa::PoissonParam< T > Class Template Reference

A one dimensional Poisson function. More...

#include <PoissonParam.h>

Inheritance diagram for casa::PoissonParam< T >:

List of all members.

Public Types
enum	{   LAMBDA,   HEIGHT }
	Parameter numbers. More...
Public Member Functions
	PoissonParam ()
	Constructs the Poisson, Defaults: lambda=1.
	PoissonParam (const T &lambda)
	PoissonParam (const T &lambda, const T &height)
	PoissonParam (const PoissonParam< T > &other)
	Copy constructor (deep copy)
template<class W >
	PoissonParam (const PoissonParam< W > &other)
PoissonParam< T > &	operator= (const PoissonParam< T > &other)
	Copy assignment (deep copy)
virtual	~PoissonParam ()
	Destructor.
virtual uInt	ndim () const
	Returns the number of dimensions of function.
virtual const String &	name () const
	Give name of function.
T	lambda () const
	Get or set lambda.
void	setLambda (const T &lambda)
T	height () const
void	setHeight (const T &height)

---

Detailed Description

template<class T>
class casa::PoissonParam< T >

A one dimensional Poisson function.

Intended use:

Internal

Review Status

Test programs:

tFunctionHolder

Prerequisite

• FunctionParam class
• Function class

Etymology

A 1-dimensional Poisson.

Synopsis

A Poisson is described by lambda The value is:

         height          (|x-center| == 0.0)
         0               (|x-center| != 0.0)

The parameters are enumerated by LAMDA. They have default values of 1.

Example

       PoissonFunction<Double> sf(5.0);
       sf(25);            // = 5.0

Template Type Argument Requirements (T)

• T should have standard numerical operators

Thrown Exceptions

• AipsError if incorrect parameter number specified.

Definition at line 82 of file PoissonParam.h.

---

Member Enumeration Documentation

template<class T>

anonymous enum

Parameter numbers.

Enumerator:

LAMBDA
HEIGHT

Definition at line 87 of file PoissonParam.h.

---

Constructor & Destructor Documentation

template<class T>

casa::PoissonParam< T >::PoissonParam

(

)

Constructs the Poisson, Defaults: lambda=1.

Warning: Could not use default arguments that worked both with gcc and IRIX

template<class T>

casa::PoissonParam< T >::PoissonParam

(

const T &

lambda

)

[explicit]

template<class T>

casa::PoissonParam< T >::PoissonParam	(	const T &	lambda,
		const T &	height
	)

template<class T>

casa::PoissonParam< T >::PoissonParam

(

const PoissonParam< T > &

other

)

Copy constructor (deep copy)

template<class T>

template<class W >

casa::PoissonParam< T >::PoissonParam

(

const PoissonParam< W > &

other

)

[inline]

Definition at line 104 of file PoissonParam.h.

template<class T>

virtual casa::PoissonParam< T >::~PoissonParam

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<class T>

T casa::PoissonParam< T >::height

(

)

const [inline]

Definition at line 132 of file PoissonParam.h.

Referenced by casa::PoissonParam< AutoDiff< T > >::setHeight().

template<class T>

T casa::PoissonParam< T >::lambda

(

)

const [inline]

Get or set lambda.

Definition at line 125 of file PoissonParam.h.

Referenced by casa::PoissonParam< AutoDiff< T > >::setLambda().

template<class T>

virtual const String& casa::PoissonParam< T >::name

(

)

const [inline, virtual]

Give name of function.

Reimplemented from casa::Function< T >.

Definition at line 118 of file PoissonParam.h.

template<class T>

virtual uInt casa::PoissonParam< T >::ndim

(

)

const [inline, virtual]

Returns the number of dimensions of function.

Implements casa::Function< T >.

Definition at line 114 of file PoissonParam.h.

template<class T>

PoissonParam<T>& casa::PoissonParam< T >::operator=

(

const PoissonParam< T > &

other

)

Copy assignment (deep copy)

template<class T>

void casa::PoissonParam< T >::setHeight

(

const T &

height

)

[inline]

Definition at line 135 of file PoissonParam.h.

template<class T>

void casa::PoissonParam< T >::setLambda

(

const T &

lambda

)

[inline]

Definition at line 128 of file PoissonParam.h.

---

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

• casacore/scimath/Functionals/PoissonParam.h