casacore
|
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 |
Returns the number of dimensions of function. More... | |
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) | |
virtual | ~Function () |
Destructor. More... | |
uInt | nparameters () const |
Returns the number of parameters. More... | |
virtual U | 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 U | operator() () const |
Evaluate this function object at x or at x, y . More... | |
virtual U | operator() (const ArgType &x) const |
virtual U | operator() (const Vector< ArgType > &x) const |
virtual U | operator() (FunctionArg x) const |
virtual U | operator() (const ArgType &x, const ArgType &y) const |
virtual U | operator() (const ArgType &x, const ArgType &y, const ArgType &z) const |
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, U > * | 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 |
Public Member Functions inherited from casacore::Functional< FunctionTraits< T >::ArgType, U > | |
virtual | ~Functional () |
Destructor. More... | |
virtual U | operator() (const FunctionTraits< T >::ArgType &x) const =0 |
Map a Domain x into a Range y value. More... | |
Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< T >::ArgType >, U > | |
virtual | ~Functional () |
Destructor. More... | |
virtual U | operator() (const Vector< FunctionTraits< T >::ArgType > &x) const =0 |
Map a Domain x into a Range y value. More... | |
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... | |
A one dimensional Poisson function.
Internal
A 1-dimensional Poisson.
A Poisson
is described by lambda The value is:
The parameters are enumerated by LAMDA. They have default values of 1.
Definition at line 83 of file PoissonParam.h.
anonymous enum |
casacore::PoissonParam< T >::PoissonParam | ( | ) |
Constructs the Poisson, Defaults: lambda=1.
Warning: Could not use default arguments that worked both with gcc and IRIX
|
explicit |
casacore::PoissonParam< T >::PoissonParam | ( | const T & | lambda, |
const T & | height | ||
) |
casacore::PoissonParam< T >::PoissonParam | ( | const PoissonParam< T > & | other | ) |
Copy constructor (deep copy)
|
inline |
Definition at line 105 of file PoissonParam.h.
|
virtual |
Destructor.
|
inline |
Definition at line 133 of file PoissonParam.h.
Referenced by casacore::PoissonParam< AutoDiff< T > >::setHeight().
|
inline |
Get or set lambda.
Definition at line 126 of file PoissonParam.h.
Referenced by casacore::PoissonParam< AutoDiff< T > >::setLambda().
|
inlinevirtual |
Give name of function.
Reimplemented from casacore::Function< T >.
Definition at line 119 of file PoissonParam.h.
|
inlinevirtual |
Returns the number of dimensions of function.
Implements casacore::Function< T >.
Definition at line 115 of file PoissonParam.h.
PoissonParam<T>& casacore::PoissonParam< T >::operator= | ( | const PoissonParam< T > & | other | ) |
Copy assignment (deep copy)
Referenced by casacore::PoissonFunction< T >::operator=().
|
inline |
Definition at line 136 of file PoissonParam.h.
|
inline |
Definition at line 129 of file PoissonParam.h.