casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
casacore::Gaussian3DParam< Type > Class Template Reference

Parameter handling for 3 dimensional Gaussian class. More...

#include <Gaussian3DParam.h>

Inheritance diagram for casacore::Gaussian3DParam< Type >:
casacore::Function< Type > casacore::Functional< Domain, Range > casacore::Functional< Domain, Range >

Public Types

enum  {
  H,
  CX,
  CY,
  CZ,
  AX,
  AY,
  AZ,
  THETA,
  PHI,
  NPAR
}
 Parameter handling for the functional for 3D Gaussian Class. More...
 
- Public Types inherited from casacore::Function< Type >
typedef FunctionTraits< Type >
::ArgType 
ArgType
 
typedef const ArgTypeFunctionArg
 

Public Member Functions

 Gaussian3DParam ()
 Constructs the three dimensional Gaussians. More...
 
 Gaussian3DParam (Type height, const Vector< Type > &center, 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 Stringname () 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 > &center)
 
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)
 
- Public Member Functions inherited from casacore::Function< Type >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< Type > &in)
 
 Function (const FunctionParam< Type > &other)
 
 Function (const Function< W, X > &other)
 
 Function (const Function< Type, U > &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...
 
Type & operator[] (const uInt n)
 Manipulate the nth parameter (0-based) with no index check. More...
 
const Type & 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
 
Boolmask (const uInt n)
 Manipulate the mask associated with the nth parameter (e.g. More...
 
const Boolmask (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, U > * 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
 
- Public Member Functions inherited from casacore::Functional< Domain, Range >
virtual ~Functional ()
 Destructor. More...
 
virtual Range operator() (const Domain &x) const =0
 Map a Domain x into a Range y value. More...
 

Protected Member Functions

void settrigvals () const
 

Protected Attributes

Type fwhm2int
 
Type stoT_p
 
Type stoP_p
 
Type cosT_p
 
Type sinT_p
 
Type cosP_p
 
Type sinP_p
 
Type cosTcosP_p
 
Type cosTsinP_p
 
Type sinTcosP_p
 
Type sinTsinP_p
 
- Protected Attributes inherited from casacore::Function< Type >
FunctionParam< Type > param_p
 The parameters and masks. More...
 
Vector< ArgTypearg_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 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:

  1. The height of the Gaussian. This is identical to the value returned using the height member function.
  2. The center of the Gaussian in the x direction. This is identical to the value returned using the xCenter member function.
  3. The center of the Gaussian in the y direction. This is identical to the value returned using the yCenter member function.
  4. The center of the Gaussian in the z direction. This is identical to the value returned using the zCenter member function.
  5. The width of the Gaussian along the x-axis.
  6. The width of the Gaussian along the y-axis.
  7. The width of the Gaussian along the z-axis.
  8. The longitudinal position angle, theta (in radians)
  9. 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)

Thrown Exceptions

To Do

Definition at line 149 of file Gaussian3DParam.h.

Member Enumeration Documentation

template<class Type>
anonymous enum

Parameter handling for the functional for 3D Gaussian Class.

Similar to Gaussian2DParam, but width parameters are not adjusted for FWHM; they are identical to the parameters used in the function.

Position angle parameters are restricted to -PI/4 < angle < PI/4.

Enumerator
H 
CX 
CY 
CZ 
AX 
AY 
AZ 
THETA 
PHI 
NPAR 

Definition at line 160 of file Gaussian3DParam.h.

Constructor & Destructor Documentation

template<class Type>
casacore::Gaussian3DParam< Type >::Gaussian3DParam ( )

Constructs the three dimensional Gaussians.

Defaults: height = 1, center = {0,0,0}, width = {1,1,1}, theta = phi = 0

template<class Type>
casacore::Gaussian3DParam< Type >::Gaussian3DParam ( Type  height,
const Vector< Type > &  center,
const Vector< Type > &  width,
Type  theta,
Type  phi 
)
template<class Type>
casacore::Gaussian3DParam< Type >::Gaussian3DParam ( Type &  height,
Type &  xCenter,
Type &  yCenter,
Type &  zCenter,
Type &  xWidth,
Type &  yWidth,
Type &  zWidth,
Type &  theta,
Type &  phi 
)
template<class Type>
casacore::Gaussian3DParam< Type >::Gaussian3DParam ( const Gaussian3DParam< Type > &  other)

Copy construcor.

template<class Type>
template<class W >
casacore::Gaussian3DParam< Type >::Gaussian3DParam ( const Gaussian3DParam< W > &  other)
inline

Definition at line 189 of file Gaussian3DParam.h.

template<class Type>
virtual casacore::Gaussian3DParam< Type >::~Gaussian3DParam ( )
virtual

Destructor.

Member Function Documentation

template<class Type>
Vector<Type> casacore::Gaussian3DParam< Type >::center ( ) const

Get or cet the center coordinates of the Gaussian.

template<class Type>
Type casacore::Gaussian3DParam< Type >::flux ( ) const

Get or set the total flux of the Gaussian.

(Note: Since this changes the height of the Gaussian but not its width, always set the width before setting the flux.)

template<class Type>
Type casacore::Gaussian3DParam< Type >::height ( ) const

Get or set the peak height of the Gaussian.

template<class Type>
virtual const String& casacore::Gaussian3DParam< Type >::name ( ) const
inlinevirtual

Give name of function.

Reimplemented from casacore::Function< Type >.

Definition at line 202 of file Gaussian3DParam.h.

template<class Type>
virtual uInt casacore::Gaussian3DParam< Type >::ndim ( ) const
inlinevirtual

Return dimensionality.

Implements casacore::Function< Type >.

Definition at line 206 of file Gaussian3DParam.h.

template<class Type>
Gaussian3DParam<Type>& casacore::Gaussian3DParam< Type >::operator= ( const Gaussian3DParam< Type > &  other)

Copy assignment.

template<class Type>
Type casacore::Gaussian3DParam< Type >::phi ( ) const
template<class Type>
void casacore::Gaussian3DParam< Type >::setCenter ( const Vector< Type > &  center)
template<class Type>
void casacore::Gaussian3DParam< Type >::setFlux ( const Type &  flux)
template<class Type>
void casacore::Gaussian3DParam< Type >::setHeight ( const Type &  height)
template<class Type>
void casacore::Gaussian3DParam< Type >::setphi ( const Type &  sP)
template<class Type>
void casacore::Gaussian3DParam< Type >::settheta ( const Type &  sT)
template<class Type>
void casacore::Gaussian3DParam< Type >::settrigvals ( ) const
protected
template<class Type>
void casacore::Gaussian3DParam< Type >::setWidth ( const Vector< Type > &  width)
template<class Type>
void casacore::Gaussian3DParam< Type >::setXcenter ( const Type &  xcenter)
template<class Type>
void casacore::Gaussian3DParam< Type >::setXwidth ( const Type &  xwidth)
template<class Type>
void casacore::Gaussian3DParam< Type >::setYcenter ( const Type &  ycenter)
template<class Type>
void casacore::Gaussian3DParam< Type >::setYwidth ( const Type &  ywidth)
template<class Type>
void casacore::Gaussian3DParam< Type >::setZcenter ( const Type &  zcenter)
template<class Type>
void casacore::Gaussian3DParam< Type >::setZwidth ( const Type &  zwidth)
template<class Type>
Type casacore::Gaussian3DParam< Type >::theta ( ) const

Get or set the rotation angles of the Gaussian.

Theta=logitude, phi=latitude

template<class Type>
Vector<Type> casacore::Gaussian3DParam< Type >::width ( ) const

Get or set the sigma-width of the Gaussian.

template<class Type>
Type casacore::Gaussian3DParam< Type >::xCenter ( ) const
template<class Type>
Type casacore::Gaussian3DParam< Type >::xWidth ( ) const
template<class Type>
Type casacore::Gaussian3DParam< Type >::yCenter ( ) const
template<class Type>
Type casacore::Gaussian3DParam< Type >::yWidth ( ) const
template<class Type>
Type casacore::Gaussian3DParam< Type >::zCenter ( ) const
template<class Type>
Type casacore::Gaussian3DParam< Type >::zWidth ( ) const

Member Data Documentation

template<class Type>
Type casacore::Gaussian3DParam< Type >::cosP_p
mutableprotected

Definition at line 264 of file Gaussian3DParam.h.

template<class Type>
Type casacore::Gaussian3DParam< Type >::cosT_p
mutableprotected

Definition at line 263 of file Gaussian3DParam.h.

template<class Type>
Type casacore::Gaussian3DParam< Type >::cosTcosP_p
mutableprotected

Definition at line 265 of file Gaussian3DParam.h.

template<class Type>
Type casacore::Gaussian3DParam< Type >::cosTsinP_p
mutableprotected

Definition at line 266 of file Gaussian3DParam.h.

template<class Type>
Type casacore::Gaussian3DParam< Type >::fwhm2int
protected

Definition at line 259 of file Gaussian3DParam.h.

template<class Type>
Type casacore::Gaussian3DParam< Type >::sinP_p
mutableprotected

Definition at line 264 of file Gaussian3DParam.h.

template<class Type>
Type casacore::Gaussian3DParam< Type >::sinT_p
mutableprotected

Definition at line 263 of file Gaussian3DParam.h.

template<class Type>
Type casacore::Gaussian3DParam< Type >::sinTcosP_p
mutableprotected

Definition at line 267 of file Gaussian3DParam.h.

template<class Type>
Type casacore::Gaussian3DParam< Type >::sinTsinP_p
mutableprotected

Definition at line 268 of file Gaussian3DParam.h.

template<class Type>
Type casacore::Gaussian3DParam< Type >::stoP_p
mutableprotected

Definition at line 262 of file Gaussian3DParam.h.

template<class Type>
Type casacore::Gaussian3DParam< Type >::stoT_p
mutableprotected

Definition at line 261 of file Gaussian3DParam.h.


The documentation for this class was generated from the following file: