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

Partial specialization of Lorentzian1D for AutoDiff More...

#include <Lorentzian1D.h>

Public Member Functions

 Lorentzian1D_PS ()
 Constructs one dimensional Lorentzians. More...
 
 Lorentzian1D_PS (const AutoDiff< T > &height)
 
 Lorentzian1D_PS (const AutoDiff< T > &height, const AutoDiff< T > &center)
 
 Lorentzian1D_PS (const AutoDiff< T > &height, const AutoDiff< T > &center, const AutoDiff< T > &width)
 
 Lorentzian1D_PS (const Lorentzian1D_PS &other)
 Copy constructor (deep copy) More...
 
template<class W >
 Lorentzian1D_PS (const Lorentzian1D_PS< W > &other)
 
Lorentzian1D_PS< AutoDiff< T > > & operator= (const Lorentzian1D_PS< AutoDiff< T > > &other)
 Copy assignment (deep copy) More...
 
virtual ~Lorentzian1D_PS ()
 Destructor. More...
 
virtual AutoDiff< T > eval (typename Function< AutoDiff< T > >::FunctionArg x) const
 Evaluate the Lorentzian 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::Lorentzian1DParam< AutoDiff< T > >
 Lorentzian1DParam ()
 Constructs the one dimensional Lorentzians. More...
 
 Lorentzian1DParam (const AutoDiff< T > &height)
 
 Lorentzian1DParam (const AutoDiff< T > &height, const AutoDiff< T > &center)
 
 Lorentzian1DParam (const AutoDiff< T > &height, const AutoDiff< T > &center, const AutoDiff< T > &width)
 
 Lorentzian1DParam (const Lorentzian1DParam< AutoDiff< T > > &other)
 Copy constructor (deep copy) More...
 
 Lorentzian1DParam (const Lorentzian1DParam< W > &other)
 
Lorentzian1DParam< AutoDiff< T > > & operator= (const Lorentzian1DParam< AutoDiff< T > > &other)
 Copy assignment (deep copy) More...
 
virtual ~Lorentzian1DParam ()
 Destructor. More...
 
virtual const Stringname () const
 Give name of function. More...
 
AutoDiff< T > height () const
 Get or set the peak height of the Lorentzian. More...
 
void setHeight (const AutoDiff< T > &height)
 
AutoDiff< T > flux () const
 Get or set the analytical integrated area underneath the Lorentzian. More...
 
void setFlux (const AutoDiff< T > &flux)
 
AutoDiff< T > center () const
 Get or set the center ordinate of the Lorentzian. More...
 
void setCenter (const AutoDiff< T > &cnter)
 
AutoDiff< T > width () const
 Get or set the FWHM of the Lorentzian. More...
 
void setWidth (const AutoDiff< T > &width)
 
- Public Member Functions inherited from casacore::Function1D< AutoDiff< T > >
 Function1D ()
 Constructors. More...
 
 Function1D (const uInt n)
 
 Function1D (const Vector< AutoDiff< T > > &in)
 
 Function1D (const FunctionParam< AutoDiff< T > > &other)
 
 Function1D (const Function1D< W, X > &other)
 
virtual ~Function1D ()
 Destructor. More...
 
virtual uInt ndim () const
 Returns the number of dimensions of function. More...
 
- Public Member Functions inherited from casacore::Function< AutoDiff< T >, 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::Lorentzian1DParam< AutoDiff< T > >
enum  
 
- Public Types inherited from casacore::Function1D< AutoDiff< T > >
typedef const AutoDiff< T > * FunctionArg
 
- Public Types inherited from casacore::Function< AutoDiff< T >, AutoDiff< T > >
typedef FunctionTraits< AutoDiff< T > >::ArgType ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Lorentzian1DParam< AutoDiff< T > >
AutoDiff< T > fwhm2int
 Constant to scale halfwidth at 1/e to FWHM. More...
 
- Protected Attributes inherited from casacore::Function< AutoDiff< T >, 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::Lorentzian1D_PS< AutoDiff< T > >

Partial specialization of Lorentzian1D for AutoDiff

Synopsis


Warning: The name Lorentzian1D_PS is only for cxx2html documentation problems; Use Lorentzian1D in your code;

Definition at line 205 of file Lorentzian1D.h.

Constructor & Destructor Documentation

◆ Lorentzian1D_PS() [1/6]

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

Constructs one dimensional Lorentzians.

Definition at line 212 of file Lorentzian1D.h.

◆ Lorentzian1D_PS() [2/6]

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

Definition at line 213 of file Lorentzian1D.h.

◆ Lorentzian1D_PS() [3/6]

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

Definition at line 215 of file Lorentzian1D.h.

◆ Lorentzian1D_PS() [4/6]

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

Definition at line 217 of file Lorentzian1D.h.

◆ Lorentzian1D_PS() [5/6]

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

Copy constructor (deep copy)

Definition at line 224 of file Lorentzian1D.h.

◆ Lorentzian1D_PS() [6/6]

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

Definition at line 227 of file Lorentzian1D.h.

◆ ~Lorentzian1D_PS()

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

Destructor.

Definition at line 237 of file Lorentzian1D.h.

Member Function Documentation

◆ clone()

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

Definition at line 249 of file Lorentzian1D.h.

◆ cloneAD()

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

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

Definition at line 252 of file Lorentzian1D.h.

◆ cloneNonAD()

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

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

Definition at line 256 of file Lorentzian1D.h.

◆ eval()

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

Evaluate the Lorentzian and its derivatives at x.

◆ operator=()

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

Copy assignment (deep copy)

Definition at line 233 of file Lorentzian1D.h.


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