casacore::PoissonFunction< T > Class Template Reference

A one dimensional Poisson function. More...

#include <PoissonFunction.h>

Inheritance diagram for casacore::PoissonFunction< T >:

List of all members.

Public Member Functions
	PoissonFunction ()
	Constructs the PoissonFunction, Defaults: lambda=1.
	PoissonFunction (const T &lambda)
	PoissonFunction (const T &lambda, const T &height)
	PoissonFunction (const PoissonFunction< T > &other)
	Copy constructor (deep copy).
template<class W >
	PoissonFunction (const PoissonFunction< W > &other)
PoissonFunction< T > &	operator= (const PoissonFunction< T > &other)
	Copy assignment (deep copy).
virtual	~PoissonFunction ()
	Destructor.
virtual T	eval (typename Function< T >::FunctionArg x) const
	Evaluate the Poisson at x.
virtual Function< T > *	clone () const
	Return a copy of this object from the heap.
virtual Function< typename FunctionTraits< T >::DiffType > *	cloneAD () const
virtual Function< typename FunctionTraits< T >::BaseType > *	cloneNonAD () const

---

Detailed Description

template<class T>
class casacore::PoissonFunction< T >

A one dimensional Poisson function.

Intended use:

Public interface

Review Status

Test programs:

tFunctionHolder

Prerequisite

• PoissonParam
• Function

Etymology

A 1-dimensional Poisson.

Synopsis

A Poisson is described by lambda. The parameters are enumerated by LAMBDA. 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 79 of file PoissonFunction.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::PoissonFunction< T >::PoissonFunction

(

)

[inline]

Constructs the PoissonFunction, Defaults: lambda=1.

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

Definition at line 88 of file PoissonFunction.h.

template<class T>

casacore::PoissonFunction< T >::PoissonFunction

(

const T &

lambda

)

[inline, explicit]

Definition at line 89 of file PoissonFunction.h.

template<class T>

casacore::PoissonFunction< T >::PoissonFunction	(	const T &	lambda,
		const T &	height
	)			[inline]

Definition at line 91 of file PoissonFunction.h.

template<class T>

casacore::PoissonFunction< T >::PoissonFunction

(

const PoissonFunction< T > &

other

)

[inline]

Copy constructor (deep copy).

Definition at line 97 of file PoissonFunction.h.

template<class T>

template<class W >

casacore::PoissonFunction< T >::PoissonFunction

(

const PoissonFunction< W > &

other

)

[inline]

Definition at line 99 of file PoissonFunction.h.

template<class T>

virtual casacore::PoissonFunction< T >::~PoissonFunction

(

)

[inline, virtual]

Destructor.

Definition at line 107 of file PoissonFunction.h.

---

Member Function Documentation

template<class T>

virtual Function<T>* casacore::PoissonFunction< T >::clone

(

)

const [inline, virtual]

Return a copy of this object from the heap.

The caller is responsible for deleting this pointer.

Implements casacore::Function< T >.

Definition at line 120 of file PoissonFunction.h.

template<class T>

virtual Function<typename FunctionTraits<T>::DiffType>* casacore::PoissonFunction< T >::cloneAD

(

)

const [inline, virtual]

Reimplemented from casacore::Function< T >.

Definition at line 121 of file PoissonFunction.h.

template<class T>

virtual Function<typename FunctionTraits<T>::BaseType>* casacore::PoissonFunction< T >::cloneNonAD

(

)

const [inline, virtual]

Reimplemented from casacore::Function< T >.

Definition at line 123 of file PoissonFunction.h.

template<class T>

virtual T casacore::PoissonFunction< T >::eval

(

typename Function< T >::FunctionArg

x

)

const [virtual]

Evaluate the Poisson at x.

If a vector is used as the argument only its first element is used.

template<class T>

PoissonFunction<T>& casacore::PoissonFunction< T >::operator=

(

const PoissonFunction< T > &

other

)

[inline]

Copy assignment (deep copy).

Reimplemented from casacore::PoissonParam< T >.

Definition at line 103 of file PoissonFunction.h.

---

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

• casacore/scimath/Functionals/PoissonFunction.h