casacore
Public Member Functions | List of all members
casacore::Gaussian2D_PS< AutoDiff< T > > Class Template Reference

Partial specialization of Gaussian2D for AutoDiff More...

#include <Gaussian2D.h>

Public Member Functions

 Gaussian2D_PS ()
 Constructs two dimensional Gaussians. More...
 
 Gaussian2D_PS (const AutoDiff< T > &height, const Vector< AutoDiff< T > > &center, const Vector< AutoDiff< T > > &width, const AutoDiff< T > &pa)
 
 Gaussian2D_PS (const AutoDiff< T > &height, const AutoDiff< T > &xCenter, const AutoDiff< T > &yCenter, const AutoDiff< T > &majorAxis, const AutoDiff< T > &axialRatio, const AutoDiff< T > &pa)
 
 Gaussian2D_PS (const Gaussian2D_PS &other)
 Copy constructor (deep copy) More...
 
template<class W >
 Gaussian2D_PS (const Gaussian2D_PS< W > &other)
 
Gaussian2D_PS< AutoDiff< T > > & operator= (const Gaussian2D_PS< AutoDiff< T > > &other)
 Copy assignment (deep copy) More...
 
virtual ~Gaussian2D_PS ()
 Destructor. More...
 
virtual AutoDiff< T > eval (typename Function< AutoDiff< T > >::FunctionArg x) const
 Evaluate the Gaussian and its derivatives at x. More...
 
virtual Function< AutoDiff< T > > * clone () const
 Return a copy of this object from the heap. More...
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * cloneAD () const
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * cloneNonAD () const
 
- Public Member Functions inherited from casacore::Gaussian2DParam< AutoDiff< T > >
 Gaussian2DParam ()
 Constructs the two dimensional Gaussians. More...
 
 Gaussian2DParam (const AutoDiff< T > &height, const Vector< AutoDiff< T > > &center, const Vector< AutoDiff< T > > &width, const AutoDiff< T > &pa)
 
 Gaussian2DParam (const AutoDiff< T > &height, const AutoDiff< T > &xCenter, const AutoDiff< T > &yCenter, const AutoDiff< T > &majorAxis, const AutoDiff< T > &axialRatio, const AutoDiff< T > &pa)
 
 Gaussian2DParam (const Gaussian2DParam< AutoDiff< T > > &other)
 Copy constructor (deep copy) More...
 
 Gaussian2DParam (const Gaussian2DParam< W > &other)
 
Gaussian2DParam< AutoDiff< T > > & operator= (const Gaussian2DParam< AutoDiff< T > > &other)
 Copy assignment (deep copy) More...
 
virtual ~Gaussian2DParam ()
 Destructor. More...
 
virtual uInt ndim () const
 Variable dimensionality. More...
 
virtual const Stringname () const
 Give name of function. More...
 
AutoDiff< T > height () const
 Get or set the peak height of the Gaussian. More...
 
void setHeight (const AutoDiff< T > &height)
 
AutoDiff< T > flux () const
 Get or set the analytical integrated area underneath the Gaussian. More...
 
void setFlux (const AutoDiff< T > &flux)
 
Vector< AutoDiff< T > > center () const
 Get or set the center ordinate of the Gaussian. More...
 
void setCenter (const Vector< AutoDiff< T > > &center)
 
AutoDiff< T > xCenter () const
 
void setXcenter (const AutoDiff< T > &cnter)
 
AutoDiff< T > yCenter () const
 
void setYcenter (const AutoDiff< T > &cnter)
 
Vector< AutoDiff< T > > width () const
 Set or get the FWHM of the Gaussian. More...
 
void setWidth (const Vector< AutoDiff< T > > &width)
 
AutoDiff< T > majorAxis () const
 
void setMajorAxis (const AutoDiff< T > &width)
 
AutoDiff< T > minorAxis () const
 
void setMinorAxis (const AutoDiff< T > &width)
 
AutoDiff< T > axialRatio () const
 
void setAxialRatio (const AutoDiff< T > &axialRatio)
 
AutoDiff< T > PA () const
 Set/get the rotation angle (orientation) of the Gaussian. More...
 
void setPA (const AutoDiff< T > &pa)
 
- Public Member Functions inherited from casacore::Function< AutoDiff< T > >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< AutoDiff< T > > &in)
 
 Function (const FunctionParam< AutoDiff< T > > &other)
 
 Function (const Function< W, X > &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 AutoDiff< T > eval (FunctionArg x) const=0
 Evaluate the function object. More...
 
AutoDiff< T > & operator[] (const uInt n)
 Manipulate the nth parameter (0-based) with no index check. More...
 
const AutoDiff< T > & operator[] (const uInt n) const
 
virtual AutoDiff< T > operator() () const
 Evaluate this function object at xor at x, y. More...
 
virtual AutoDiff< T > operator() (const ArgType &x) const
 
virtual AutoDiff< T > operator() (const Vector< ArgType > &x) const
 
virtual AutoDiff< T > operator() (FunctionArg x) const
 
virtual AutoDiff< T > operator() (const ArgType &x, const ArgType &y) const
 
virtual AutoDiff< T > operator() (const ArgType &x, const ArgType &y, const ArgType &z) const
 
virtual const Stringname () const
 Specify the name associated with the function (default will be unknown) More...
 
Boolmask (const uInt n)
 Manipulate the mask associated with the nth parameter (e.g. More...
 
const Boolmask (const uInt n) const
 
const FunctionParam< AutoDiff< T > > & parameters () const
 Return the parameter interface. More...
 
FunctionParam< AutoDiff< 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< AutoDiff< T >, AutoDiff< T > > * clone () const=0
 Return a copy of this object from the heap. More...
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * cloneAD () const
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * cloneNonAD () const
 
- Public Member Functions inherited from casacore::Functional< FunctionTraits< AutoDiff< T > >::ArgType, AutoDiff< T > >
virtual ~Functional ()
 Destructor. More...
 
virtual AutoDiff< T > operator() (const FunctionTraits< AutoDiff< T > >::ArgType &x) const=0
 Map a Domain x into a Range y value. More...
 
- Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< AutoDiff< T > >::ArgType >, AutoDiff< T > >
virtual ~Functional ()
 Destructor. More...
 
virtual AutoDiff< T > operator() (const Vector< FunctionTraits< AutoDiff< T > >::ArgType > &x) const=0
 Map a Domain x into a Range y value. More...
 

Additional Inherited Members

- Public Types inherited from casacore::Gaussian2DParam< AutoDiff< T > >
enum  
 
- Public Types inherited from casacore::Function< AutoDiff< T > >
typedef FunctionTraits< AutoDiff< T > >::ArgType ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Gaussian2DParam< AutoDiff< T > >
AutoDiff< T > fwhm2int
 Constant to scale halfwidth at 1/e to FWHM. More...
 
AutoDiff< T > thePA
 cached vale of the PA More...
 
AutoDiff< T > theSpa
 cached values of the cos and sine of thePA More...
 
AutoDiff< T > theCpa
 
AutoDiff< T > theXwidth
 cached vale of the Xwidth = ratio*theYwidth; More...
 
- Protected Attributes inherited from casacore::Function< AutoDiff< T > >
FunctionParam< AutoDiff< T > > 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 T>
class casacore::Gaussian2D_PS< AutoDiff< T > >

Partial specialization of Gaussian2D for AutoDiff

Synopsis


Warning: The name Gaussian2D_PS is only for cxx2html documentation problems; Use Gaussian2D in your code;

Definition at line 256 of file Gaussian2D.h.

Constructor & Destructor Documentation

◆ Gaussian2D_PS() [1/5]

template<class T >
casacore::Gaussian2D_PS< AutoDiff< T > >::Gaussian2D_PS ( )
inline

Constructs two dimensional Gaussians.

Definition at line 263 of file Gaussian2D.h.

◆ Gaussian2D_PS() [2/5]

template<class T >
casacore::Gaussian2D_PS< AutoDiff< T > >::Gaussian2D_PS ( const AutoDiff< T > &  height,
const Vector< AutoDiff< T > > &  center,
const Vector< AutoDiff< T > > &  width,
const AutoDiff< T > &  pa 
)
inline

Definition at line 264 of file Gaussian2D.h.

◆ Gaussian2D_PS() [3/5]

template<class T >
casacore::Gaussian2D_PS< AutoDiff< T > >::Gaussian2D_PS ( const AutoDiff< T > &  height,
const AutoDiff< T > &  xCenter,
const AutoDiff< T > &  yCenter,
const AutoDiff< T > &  majorAxis,
const AutoDiff< T > &  axialRatio,
const AutoDiff< T > &  pa 
)
inline

Definition at line 269 of file Gaussian2D.h.

◆ Gaussian2D_PS() [4/5]

template<class T >
casacore::Gaussian2D_PS< AutoDiff< T > >::Gaussian2D_PS ( const Gaussian2D_PS< AutoDiff< T > > &  other)
inline

Copy constructor (deep copy)

Definition at line 278 of file Gaussian2D.h.

◆ Gaussian2D_PS() [5/5]

template<class T >
template<class W >
casacore::Gaussian2D_PS< AutoDiff< T > >::Gaussian2D_PS ( const Gaussian2D_PS< W > &  other)
inline

Definition at line 281 of file Gaussian2D.h.

◆ ~Gaussian2D_PS()

template<class T >
virtual casacore::Gaussian2D_PS< AutoDiff< T > >::~Gaussian2D_PS ( )
inlinevirtual

Destructor.

Definition at line 291 of file Gaussian2D.h.

Member Function Documentation

◆ clone()

template<class T >
virtual Function< AutoDiff< T > > * casacore::Gaussian2D_PS< AutoDiff< T > >::clone ( ) const
inlinevirtual

Return a copy of this object from the heap.

The caller is responsible for deleting this pointer.

Implements casacore::Function< AutoDiff< T > >.

Definition at line 303 of file Gaussian2D.h.

◆ cloneAD()

template<class T >
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * casacore::Gaussian2D_PS< AutoDiff< T > >::cloneAD ( ) const
inlinevirtual

Reimplemented from casacore::Function< AutoDiff< T > >.

Definition at line 306 of file Gaussian2D.h.

◆ cloneNonAD()

template<class T >
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * casacore::Gaussian2D_PS< AutoDiff< T > >::cloneNonAD ( ) const
inlinevirtual

Reimplemented from casacore::Function< AutoDiff< T > >.

Definition at line 310 of file Gaussian2D.h.

◆ eval()

template<class T >
virtual AutoDiff< T > casacore::Gaussian2D_PS< AutoDiff< T > >::eval ( typename Function< AutoDiff< T > >::FunctionArg  x) const
virtual

Evaluate the Gaussian and its derivatives at x.

◆ operator=()

template<class T >
Gaussian2D_PS< AutoDiff< T > > & casacore::Gaussian2D_PS< AutoDiff< T > >::operator= ( const Gaussian2D_PS< AutoDiff< T > > &  other)
inline

Copy assignment (deep copy)

Definition at line 287 of file Gaussian2D.h.


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