casacore
Loading...
Searching...
No Matches
casacore::Gaussian1D_PS< AutoDiff< T > > Class Template Reference

Partial specialization of Gaussian1D for AutoDiff More...

#include <Gaussian1D.h>

Public Member Functions

 Gaussian1D_PS ()
 Constructs one dimensional Gaussians.
 
 Gaussian1D_PS (const AutoDiff< T > &height)
 
 Gaussian1D_PS (const AutoDiff< T > &height, const AutoDiff< T > &center)
 
 Gaussian1D_PS (const AutoDiff< T > &height, const AutoDiff< T > &center, const AutoDiff< T > &width)
 
 Gaussian1D_PS (const Gaussian1D_PS &other)
 Copy constructor (deep copy)
 
template<class W >
 Gaussian1D_PS (const Gaussian1D_PS< W > &other)
 
Gaussian1D_PS< AutoDiff< T > > & operator= (const Gaussian1D_PS< AutoDiff< T > > &other)
 Copy assignment (deep copy)
 
virtual ~Gaussian1D_PS ()
 Destructor.
 
virtual AutoDiff< T > eval (typename Function< AutoDiff< T > >::FunctionArg x) const
 Evaluate the Gaussian and its derivatives at x.
 
virtual Function< AutoDiff< T > > * clone () const
 Return a copy of this object from the heap.
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * cloneAD () const
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * cloneNonAD () const
 
- Public Member Functions inherited from casacore::Gaussian1DParam< AutoDiff< T > >
 Gaussian1DParam ()
 Constructs the one dimensional Gaussians.
 
 Gaussian1DParam (const T &height)
 
 Gaussian1DParam (const T &height, const T &center)
 
 Gaussian1DParam (const T &height, const T &center, const T &width)
 
 Gaussian1DParam (const Gaussian1DParam< T > &other)
 Copy constructor (deep copy)
 
 Gaussian1DParam (const Gaussian1DParam< W > &other)
 
Gaussian1DParam< T > & operator= (const Gaussian1DParam< T > &other)
 Copy assignment (deep copy)
 
virtual ~Gaussian1DParam ()
 Destructor.
 
virtual const Stringname () const
 Give name of function.
 
height () const
 Get or set the peak height of the Gaussian.
 
void setHeight (const T &height)
 
flux () const
 Get or set the analytical integrated area underneath the Gaussian.
 
void setFlux (const T &flux)
 
center () const
 Get or set the center ordinate of the Gaussian.
 
void setCenter (const T &cnter)
 
width () const
 Get or set the FWHM of the Gaussian.
 
void setWidth (const T &width)
 
- Public Member Functions inherited from casacore::Function1D< T, U >
 Function1D ()
 Constructors.
 
 Function1D (const uInt n)
 
 Function1D (const Vector< T > &in)
 
 Function1D (const FunctionParam< T > &other)
 
template<class W , class X >
 Function1D (const Function1D< W, X > &other)
 
virtual ~Function1D ()
 Destructor.
 
virtual uInt ndim () const
 Returns the number of dimensions of function.
 
- Public Member Functions inherited from casacore::Function< T, T >
 Function ()
 Constructors.
 
 Function (const uInt n)
 
 Function (const Vector< T > &in)
 
 Function (const FunctionParam< T > &other)
 
 Function (const Function< W, X > &other)
 
virtual ~Function ()
 Destructor.
 
uInt nparameters () const
 Returns the number of parameters.
 
virtual T eval (FunctionArg x) const=0
 Evaluate the function object.
 
T & operator[] (const uInt n)
 Manipulate the nth parameter (0-based) with no index check.
 
const T & operator[] (const uInt n) const
 
virtual T operator() () const
 Evaluate this function object at xor at x, y.
 
virtual T operator() (const ArgType &x) const
 
virtual T operator() (const Vector< ArgType > &x) const
 
virtual T operator() (FunctionArg x) const
 
virtual T operator() (const ArgType &x, const ArgType &y) const
 
virtual T 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.
 
const Boolmask (const uInt n) const
 
const FunctionParam< T > & parameters () const
 Return the parameter interface.
 
FunctionParam< T > & parameters ()
 
const Vector< ArgType > & argp () const
 Get arg_p and parset_p.
 
Bool parsetp () const
 
void lockParam ()
 Compiler cannot always find the correct 'const' version of parameter access.
 
void unlockParam ()
 
virtual void setMode (const RecordInterface &mode)
 get/set the function mode.
 
virtual void getMode (RecordInterface &mode) const
 
virtual Bool hasMode () const
 return True if the implementing function supports a mode.
 
ostream & print (ostream &os) const
 Print the function (i.e.
 
- Public Member Functions inherited from casacore::Functional< FunctionTraits< T >::ArgType, T >
virtual ~Functional ()
 Destructor.
 
virtual T operator() (const FunctionTraits< T >::ArgType &x) const=0
 Map a Domain x into a Range y value.
 
- Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< T >::ArgType >, T >
virtual ~Functional ()
 Destructor.
 
virtual T operator() (const Vector< FunctionTraits< T >::ArgType > &x) const=0
 Map a Domain x into a Range y value.
 

Additional Inherited Members

- Public Types inherited from casacore::Gaussian1DParam< AutoDiff< T > >
enum  
 
- Public Types inherited from casacore::Function1D< T, U >
typedef const T * FunctionArg
 
- Public Types inherited from casacore::Function< T, T >
typedef FunctionTraits< T >::ArgType ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Gaussian1DParam< AutoDiff< T > >
fwhm2int
 Constant to scale halfwidth at 1/e to FWHM.
 
- Protected Attributes inherited from casacore::Function< T, T >
FunctionParam< T > param_p
 The parameters and masks.
 
Vector< ArgTypearg_p
 Aid for non-contiguous argument storage.
 
Bool parset_p
 Indicate parameter written.
 
Bool locked_p
 Indicate that parameters are expected to be locked from changing.
 

Detailed Description

template<class T>
class casacore::Gaussian1D_PS< AutoDiff< T > >

Partial specialization of Gaussian1D for AutoDiff

Synopsis


Warning: The name Gaussian1D_PS is only for cxx2html documentation problems; Use Gaussian1D in your code;

Definition at line 202 of file Gaussian1D.h.

Constructor & Destructor Documentation

◆ Gaussian1D_PS() [1/6]

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

Constructs one dimensional Gaussians.

Definition at line 209 of file Gaussian1D.h.

◆ Gaussian1D_PS() [2/6]

template<class T >
casacore::Gaussian1D_PS< AutoDiff< T > >::Gaussian1D_PS ( const AutoDiff< T > & height)
inlineexplicit

Definition at line 210 of file Gaussian1D.h.

◆ Gaussian1D_PS() [3/6]

template<class T >
casacore::Gaussian1D_PS< AutoDiff< T > >::Gaussian1D_PS ( const AutoDiff< T > & height,
const AutoDiff< T > & center )
inline

Definition at line 212 of file Gaussian1D.h.

◆ Gaussian1D_PS() [4/6]

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

Definition at line 214 of file Gaussian1D.h.

◆ Gaussian1D_PS() [5/6]

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

Copy constructor (deep copy)

Definition at line 221 of file Gaussian1D.h.

◆ Gaussian1D_PS() [6/6]

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

Definition at line 224 of file Gaussian1D.h.

◆ ~Gaussian1D_PS()

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

Destructor.

Definition at line 234 of file Gaussian1D.h.

Member Function Documentation

◆ clone()

template<class T >
virtual Function< AutoDiff< T > > * casacore::Gaussian1D_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< T, T >.

Definition at line 246 of file Gaussian1D.h.

◆ cloneAD()

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

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

Definition at line 249 of file Gaussian1D.h.

◆ cloneNonAD()

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

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

Definition at line 253 of file Gaussian1D.h.

◆ eval()

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

Evaluate the Gaussian and its derivatives at x.

◆ operator=()

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

Copy assignment (deep copy)

Definition at line 230 of file Gaussian1D.h.


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