A one dimensional Poisson function. More...
#include <PoissonParam.h>
Public Types | |
| enum | { LAMBDA, HEIGHT } |
| Parameter numbers. More... | |
 Public Types inherited from casacore::Function< T > | |
| typedef FunctionTraits< T >::ArgType | ArgType |
| typedef const ArgType * | FunctionArg |
Public Member Functions | |
| PoissonParam () | |
| Constructs the Poisson, Defaults: lambda=1. More... | |
| PoissonParam (const T &lambda) | |
| PoissonParam (const T &lambda, const T &height) | |
| PoissonParam (const PoissonParam< T > &other) | |
| Copy constructor (deep copy) More... | |
| template<class W > | |
| PoissonParam (const PoissonParam< W > &other) | |
| PoissonParam< T > & | operator= (const PoissonParam< T > &other) |
| Copy assignment (deep copy) More... | |
| virtual | ~PoissonParam () |
| Destructor. More... | |
| virtual uInt | ndim () const |
| virtual const String & | name () const |
| Give name of function. More... | |
| T | lambda () const |
| Get or set lambda. More... | |
| void | setLambda (const T &lambda) |
| T | height () const |
| void | setHeight (const T &height) |
| Public Member Functions inherited from casacore::Function< T > | |
| Function () | |
| Constructors. More... | |
| Function (const uInt n) | |
| Function (const Vector< T > &in) | |
| Function (const FunctionParam< T > &other) | |
| Function (const Function< W, X > &other) | |
| Function (const Function< T, T > &other) | |
| virtual | ~Function () |
| Destructor. More... | |
| virtual uInt | ndim () const=0 |
| Returns the number of dimensions of function. More... | |
| uInt | nparameters () const |
| Returns the number of parameters. More... | |
| virtual T | eval (FunctionArg x) const=0 |
| Evaluate the function object. More... | |
| T & | operator[] (const uInt n) |
| Manipulate the nth parameter (0-based) with no index check. More... | |
| const T & | operator[] (const uInt n) const |
| virtual T | operator() () const |
Evaluate this function object at xor at x, y. More... | |
| virtual T | operator() (const ArgType &x) const |
| virtual T | operator() (const Vector< ArgType > &x) const |
| virtual T | operator() (FunctionArg x) const |
| virtual T | operator() (const ArgType &x, const ArgType &y) const |
| virtual T | operator() (const ArgType &x, const ArgType &y, const ArgType &z) const |
| virtual const String & | name () const |
Specify the name associated with the function (default will be unknown) More... | |
| Bool & | mask (const uInt n) |
| Manipulate the mask associated with the nth parameter (e.g. More... | |
| const Bool & | mask (const uInt n) const |
| const FunctionParam< T > & | parameters () const |
| Return the parameter interface. More... | |
| FunctionParam< T > & | parameters () |
| const Vector< ArgType > & | argp () const |
Get arg_p and parset_p. More... | |
| Bool | parsetp () const |
| void | lockParam () |
| Compiler cannot always find the correct 'const' version of parameter access. More... | |
| void | unlockParam () |
| virtual void | setMode (const RecordInterface &mode) |
| get/set the function mode. More... | |
| virtual void | getMode (RecordInterface &mode) const |
| virtual Bool | hasMode () const |
| return True if the implementing function supports a mode. More... | |
| ostream & | print (ostream &os) const |
| Print the function (i.e. More... | |
| virtual Function< T, T > * | clone () const=0 |
| Return a copy of this object from the heap. More... | |
| virtual Function< typename FunctionTraits< T >::DiffType > * | cloneAD () const |
| virtual Function< typename FunctionTraits< T >::BaseType > * | cloneNonAD () const |
Additional Inherited Members | |
| Protected Attributes inherited from casacore::Function< T > | |
| FunctionParam< T > | param_p |
| The parameters and masks. More... | |
| Vector< ArgType > | arg_p |
| Aid for non-contiguous argument storage. More... | |
| Bool | parset_p |
| Indicate parameter written. More... | |
| Bool | locked_p |
| Indicate that parameters are expected to be locked from changing. More... | |
Detailed Description
template<class T>
class casacore::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 83 of file PoissonParam.h.
Member Enumeration Documentation
◆ anonymous enum
template<class T >
| anonymous enum |
Constructor & Destructor Documentation
◆ PoissonParam() [1/5]
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
◆ PoissonParam() [2/5]
template<class T >
|
explicit |
◆ PoissonParam() [3/5]
template<class T >
| casacore::PoissonParam< T >::PoissonParam | ( | const T & | lambda, |
| const T & | height | ||
| ) |
◆ PoissonParam() [4/5]
template<class T >
| casacore::PoissonParam< T >::PoissonParam | ( | const PoissonParam< T > & | other | ) |
Copy constructor (deep copy)
◆ PoissonParam() [5/5]
template<class T >
template<class W >
|
inline |
Definition at line 105 of file PoissonParam.h.
◆ ~PoissonParam()
template<class T >
|
virtual |
Destructor.
Member Function Documentation
◆ height()
template<class T >
|
inline |
Definition at line 133 of file PoissonParam.h.
Referenced by casacore::PoissonParam< AutoDiff< T > >::setHeight().
◆ lambda()
template<class T >
|
inline |
Get or set lambda.
Definition at line 126 of file PoissonParam.h.
Referenced by casacore::PoissonParam< AutoDiff< T > >::setLambda().
◆ name()
template<class T >
|
inlinevirtual |
Give name of function.
Definition at line 119 of file PoissonParam.h.
◆ ndim()
template<class T >
|
inlinevirtual |
Definition at line 115 of file PoissonParam.h.
◆ operator=()
template<class T >
| PoissonParam<T>& casacore::PoissonParam< T >::operator= | ( | const PoissonParam< T > & | other | ) |
Copy assignment (deep copy)
Referenced by casacore::PoissonFunction< T >::operator=().
◆ setHeight()
template<class T >
|
inline |
Definition at line 136 of file PoissonParam.h.
◆ setLambda()
template<class T >
|
inline |
Definition at line 129 of file PoissonParam.h.
The documentation for this class was generated from the following file:
- scimath/Functionals/PoissonParam.h
