|
casacore
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
casacore
|
Parameter handling for a hyper plane function. More...
#include <HyperPlaneParam.h>
Public Member Functions | |
| HyperPlaneParam (uInt m=0) | |
| Construct an m-dimensional hyper plane which has m parameters. More... | |
| HyperPlaneParam (const HyperPlaneParam &other) | |
| Copy constructor (deep copy) More... | |
| template<class W > | |
| HyperPlaneParam (const HyperPlaneParam< W > &other) | |
| HyperPlaneParam< T > & | operator= (const HyperPlaneParam< T > &other) |
| Copy assignment (deep copy) More... | |
| virtual | ~HyperPlaneParam () |
| Destructor. More... | |
| Bool | operator== (const HyperPlaneParam< T > &other) const |
| Comparisons. More... | |
| Bool | operator!= (const HyperPlaneParam< T > &other) const |
| virtual const String & | name () const |
| Give name of function. More... | |
| virtual uInt | ndim () const |
| What is the dimension of the parameter list. More... | |
 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 xor 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 | |
| Public Types inherited from casacore::Function< T > | |
| typedef FunctionTraits< T > ::ArgType | ArgType |
| typedef const ArgType * | FunctionArg |
| 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... | |
Parameter handling for a hyper plane function.
Internal
This class forms a function of the form f(x0,x1,..,xm-1) = p0*x0 + p1*x1 +...
f(x0,x1,..,xm-1) represents a hyper plane of dimension m.
Since the HyperPlane is a Function, the derivatives can be obtained as well.
The parameter interface (see FunctionParam class), is used to provide an interface to the Fitting classes.
This class is in general used implicitly by the HyperPlane class only.
This class was created to facilitate linear constraint functions for the use of least-squares fits.
Definition at line 108 of file HyperPlaneParam.h.
|
explicit |
Construct an m-dimensional hyper plane which has m parameters.
By default, the coefficients are initialized to zero. The default plane has m=0
| casacore::HyperPlaneParam< T >::HyperPlaneParam | ( | const HyperPlaneParam< T > & | other | ) |
Copy constructor (deep copy)
|
inline |
Definition at line 123 of file HyperPlaneParam.h.
|
virtual |
Destructor.
|
inlinevirtual |
Give name of function.
Reimplemented from casacore::Function< T >.
Definition at line 146 of file HyperPlaneParam.h.
|
inlinevirtual |
What is the dimension of the parameter list.
Implements casacore::Function< T >.
Definition at line 150 of file HyperPlaneParam.h.
|
inline |
Definition at line 140 of file HyperPlaneParam.h.
| HyperPlaneParam<T>& casacore::HyperPlaneParam< T >::operator= | ( | const HyperPlaneParam< T > & | other | ) |
Copy assignment (deep copy)
Referenced by casacore::HyperPlane< T >::operator=().
|
inline |
Comparisons.
HyperPlanes are equal if they are of the same order and have the same parameters
Definition at line 138 of file HyperPlaneParam.h.
1.8.5