casacore::PoissonParam< T > Class Template Reference

A one dimensional Poisson function. More...

#include <PoissonParam.h>

Inheritance diagram for casacore::PoissonParam< T >:
casacore::Function< T > casacore::Functional< FunctionTraits< T >::ArgType, T > casacore::Functional< Vector< FunctionTraits< T >::ArgType >, T > casacore::PoissonFunction< 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 Stringname () const
 Give name of function.
lambda () const
 Get or set lambda.
void setLambda (const T &lambda)
height () const
void setHeight (const T &height)

Detailed Description

template<class T>
class casacore::PoissonParam< T >

A one dimensional Poisson function.

Intended use:

Internal

Review Status

Test programs:
tFunctionHolder

Prerequisite

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)

Thrown Exceptions

Definition at line 83 of file PoissonParam.h.


Member Enumeration Documentation

template<class T>
anonymous enum

Parameter numbers.

Enumerator:
LAMBDA 
HEIGHT 

Definition at line 88 of file PoissonParam.h.


Constructor & Destructor Documentation

template<class T>
casacore::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>
casacore::PoissonParam< T >::PoissonParam ( const T &  lambda  )  [explicit]
template<class T>
casacore::PoissonParam< T >::PoissonParam ( const T &  lambda,
const T &  height 
)
template<class T>
casacore::PoissonParam< T >::PoissonParam ( const PoissonParam< T > &  other  ) 

Copy constructor (deep copy).

template<class T>
template<class W >
casacore::PoissonParam< T >::PoissonParam ( const PoissonParam< W > &  other  )  [inline]

Definition at line 105 of file PoissonParam.h.

template<class T>
virtual casacore::PoissonParam< T >::~PoissonParam (  )  [virtual]

Destructor.


Member Function Documentation

template<class T>
T casacore::PoissonParam< T >::height (  )  const [inline]

Definition at line 133 of file PoissonParam.h.

template<class T>
T casacore::PoissonParam< T >::lambda (  )  const [inline]

Get or set lambda.

Definition at line 126 of file PoissonParam.h.

template<class T>
virtual const String& casacore::PoissonParam< T >::name (  )  const [inline, virtual]

Give name of function.

Reimplemented from casacore::Function< T >.

Definition at line 119 of file PoissonParam.h.

template<class T>
virtual uInt casacore::PoissonParam< T >::ndim (  )  const [inline, virtual]

Returns the number of dimensions of function.

Implements casacore::Function< T >.

Definition at line 115 of file PoissonParam.h.

template<class T>
PoissonParam<T>& casacore::PoissonParam< T >::operator= ( const PoissonParam< T > &  other  ) 

Copy assignment (deep copy).

Reimplemented in casacore::PoissonFunction< T >.

template<class T>
void casacore::PoissonParam< T >::setHeight ( const T &  height  )  [inline]

Definition at line 136 of file PoissonParam.h.

template<class T>
void casacore::PoissonParam< T >::setLambda ( const T &  lambda  )  [inline]

Definition at line 129 of file PoissonParam.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1