|
| | Gaussian3DParam () |
| | Constructs the three dimensional Gaussians. More...
|
| |
| | Gaussian3DParam (Type height, const Vector< Type > ¢er, const Vector< Type > &width, Type theta, Type phi) |
| |
| | Gaussian3DParam (Type &height, Type &xCenter, Type &yCenter, Type &zCenter, Type &xWidth, Type &yWidth, Type &zWidth, Type &theta, Type &phi) |
| |
| | Gaussian3DParam (const Gaussian3DParam< Type > &other) |
| | Copy construcor. More...
|
| |
| template<class W > |
| | Gaussian3DParam (const Gaussian3DParam< W > &other) |
| |
| Gaussian3DParam< Type > & | operator= (const Gaussian3DParam< Type > &other) |
| | Copy assignment. More...
|
| |
| virtual | ~Gaussian3DParam () |
| | Destructor. More...
|
| |
| virtual const String & | name () const |
| | Give name of function. More...
|
| |
| virtual uInt | ndim () const |
| | Return dimensionality. More...
|
| |
| Type | height () const |
| | Get or set the peak height of the Gaussian. More...
|
| |
| void | setHeight (const Type &height) |
| |
| Type | flux () const |
| | Get or set the total flux of the Gaussian. More...
|
| |
| void | setFlux (const Type &flux) |
| |
| Vector< Type > | center () const |
| | Get or cet the center coordinates of the Gaussian. More...
|
| |
| void | setCenter (const Vector< Type > ¢er) |
| |
| Type | xCenter () const |
| |
| void | setXcenter (const Type &xcenter) |
| |
| Type | yCenter () const |
| |
| void | setYcenter (const Type &ycenter) |
| |
| Type | zCenter () const |
| |
| void | setZcenter (const Type &zcenter) |
| |
| Vector< Type > | width () const |
| | Get or set the sigma-width of the Gaussian. More...
|
| |
| void | setWidth (const Vector< Type > &width) |
| |
| void | setXwidth (const Type &xwidth) |
| |
| Type | xWidth () const |
| |
| void | setYwidth (const Type &ywidth) |
| |
| Type | yWidth () const |
| |
| void | setZwidth (const Type &zwidth) |
| |
| Type | zWidth () const |
| |
| Type | theta () const |
| | Get or set the rotation angles of the Gaussian. More...
|
| |
| void | settheta (const Type &sT) |
| |
| Type | phi () const |
| |
| void | setphi (const Type &sP) |
| |
| | Function () |
| | Constructors. More...
|
| |
| | Function (const uInt n) |
| |
| | Function (const Vector< Type > &in) |
| |
| | Function (const FunctionParam< Type > &other) |
| |
| | Function (const Function< W, X > &other) |
| |
| virtual | ~Function () |
| | Destructor. More...
|
| |
| uInt | nparameters () const |
| | Returns the number of parameters. More...
|
| |
| virtual Type | eval (FunctionArg x) const=0 |
| | Evaluate the function object. More...
|
| |
| Type & | operator[] (const uInt n) |
| | Manipulate the nth parameter (0-based) with no index check. More...
|
| |
| const Type & | operator[] (const uInt n) const |
| |
| virtual Type | operator() () const |
| | Evaluate this function object at xor at x, y. More...
|
| |
| virtual Type | operator() (const ArgType &x) const |
| |
| virtual Type | operator() (const Vector< ArgType > &x) const |
| |
| virtual Type | operator() (FunctionArg x) const |
| |
| virtual Type | operator() (const ArgType &x, const ArgType &y) const |
| |
| virtual Type | 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< Type > & | parameters () const |
| | Return the parameter interface. More...
|
| |
| FunctionParam< Type > & | 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< Type, Type > * | clone () const=0 |
| | Return a copy of this object from the heap. More...
|
| |
| virtual Function< typename FunctionTraits< Type >::DiffType > * | cloneAD () const |
| |
| virtual Function< typename FunctionTraits< Type >::BaseType > * | cloneNonAD () const |
| |
| virtual | ~Functional () |
| | Destructor. More...
|
| |
| virtual Range | operator() (const Domain &x) const =0 |
| | Map a Domain x into a Range y value. More...
|
| |
template<class Type>
class casacore::Gaussian3DParam< Type >
Parameter handling for 3 dimensional Gaussian class
Intended use:
Internal
Review Status
- Test programs:
- tGaussian3DParam
Prerequisite
Etymology
A 3-dimensional Gaussian's parameters.
Synopsis
A Gaussian3D is described by a height, center, width,
and two position angles.
The width of the Gaussian is now specified in terms of the full width at half maximum (FWHM), as with the 1D and 2D Gaussian functional classes.
The three axis values refer to the x, y, and z axes, and unlike with the 2D Gaussian any of the three axes may be the longest. Instead, the position angles are restricted: The first position angle, theta, is the longitudinal angle, referring to the rotation (counterclockwise) around the z-axis. The second, phi, is the latidudinal angle, referring to the rotation around the theta-rotated y axis. The domain of both angles is -pi/4 < A < pi/4. (Note that the use of theta and phi corresponds to the mathematical convention for these angles, not the physics convention.)
The parameter interface (see FunctionParam class), is used to provide an interface to the Fitting classes.
There are 9 parameters that are used to describe the Gaussian:
-
The height of the Gaussian. This is identical to the value returned using the
height member function.
-
The center of the Gaussian in the x direction. This is identical to the value returned using the
xCenter member function.
-
The center of the Gaussian in the y direction. This is identical to the value returned using the
yCenter member function.
-
The center of the Gaussian in the z direction. This is identical to the value returned using the
zCenter member function.
-
The width of the Gaussian along the x-axis.
-
The width of the Gaussian along the y-axis.
-
The width of the Gaussian along the z-axis.
-
The longitudinal position angle, theta (in radians)
-
The latitudinal position angle, phi (also in radians).
An enumeration for the H, CX, CY,CZ, AX, AY, AZ, THETA, PHI parameter index is provided, enabling the setting and reading of parameters with the [] operator. The mask() methods can be used to check and set the parameter masks.
This class is in general used implicitly by the Gaussian3D class only.
Tip: Other points to bear in mind when fitting this class to measured data are:
-
If you need to fit a circular Gaussian to data you should mask one or both position angles; This avoids rank deficiency in the fitting routines as the position angle is meaningless when the axes are equal;
Example
Gaussian3D<Double> g(9.0, 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 0.0, 0.0);
Vector<Double> x(3);
x(0) = 1.0; x(1) = 0.5; x(2) = 0.0
cout << "g(" << x(0) << "," << x(1) << "," << x(2) << ")=" << g(x) << endl;
Template Type Argument Requirements (T)
-
T should have standard numerical operators and exp() function. Current implementation only tested for real types (and AutoDiff of them).
Thrown Exceptions
-
Assertion in debug mode if attempt is made to set a negative width
-
AipsError if incorrect parameter number specified.
-
others?
To Do
-
Gaussians that know about their DFT's could be required eventually.
Definition at line 147 of file Gaussian3DParam.h.
Public Types inherited from casacore::Function< Type >