casacore
|
Partial specialization of Lorentzian1D for AutoDiff
More...
#include <Lorentzian1D.h>
Public Member Functions | |
Lorentzian1D_PS () | |
Constructs one dimensional Lorentzians. | |
Lorentzian1D_PS (const AutoDiff< T > &height) | |
Lorentzian1D_PS (const AutoDiff< T > &height, const AutoDiff< T > ¢er) | |
Lorentzian1D_PS (const AutoDiff< T > &height, const AutoDiff< T > ¢er, const AutoDiff< T > &width) | |
Lorentzian1D_PS (const Lorentzian1D_PS &other) | |
Copy constructor (deep copy) | |
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) | |
virtual | ~Lorentzian1D_PS () |
Destructor. | |
virtual AutoDiff< T > | eval (typename Function< AutoDiff< T > >::FunctionArg x) const |
Evaluate the Lorentzian 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 |
![]() | |
Lorentzian1DParam () | |
Constructs the one dimensional Lorentzians. | |
Lorentzian1DParam (const T &height) | |
Lorentzian1DParam (const T &height, const T ¢er) | |
Lorentzian1DParam (const T &height, const T ¢er, const T &width) | |
Lorentzian1DParam (const Lorentzian1DParam< T > &other) | |
Copy constructor (deep copy) | |
Lorentzian1DParam (const Lorentzian1DParam< W > &other) | |
Lorentzian1DParam< T > & | operator= (const Lorentzian1DParam< T > &other) |
Copy assignment (deep copy) | |
virtual | ~Lorentzian1DParam () |
Destructor. | |
virtual const String & | name () const |
Give name of function. | |
T | height () const |
Get or set the peak height of the Lorentzian. | |
void | setHeight (const T &height) |
T | flux () const |
Get or set the analytical integrated area underneath the Lorentzian. | |
void | setFlux (const T &flux) |
T | center () const |
Get or set the center ordinate of the Lorentzian. | |
void | setCenter (const T &cnter) |
T | width () const |
Get or set the FWHM of the Lorentzian. | |
void | setWidth (const T &width) |
![]() | |
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. | |
![]() | |
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 x or 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 |
Bool & | mask (const uInt n) |
Manipulate the mask associated with the nth parameter (e.g. | |
const Bool & | mask (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. | |
![]() | |
virtual | ~Functional () |
Destructor. | |
virtual T | operator() (const FunctionTraits< T >::ArgType &x) const=0 |
Map a Domain x into a Range y value. | |
![]() | |
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 | |
![]() | |
enum | |
![]() | |
typedef const T * | FunctionArg |
![]() | |
typedef FunctionTraits< T >::ArgType | ArgType |
typedef const ArgType * | FunctionArg |
![]() | |
T | fwhm2int |
Constant to scale halfwidth at 1/e to FWHM. | |
![]() | |
FunctionParam< T > | param_p |
The parameters and masks. | |
Vector< ArgType > | arg_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. | |
Partial specialization of Lorentzian1D for AutoDiff
Warning: The name Lorentzian1D_PS
is only for cxx2html documentation problems; Use Lorentzian1D
in your code;
Definition at line 203 of file Lorentzian1D.h.
|
inline |
Constructs one dimensional Lorentzians.
Definition at line 210 of file Lorentzian1D.h.
|
inlineexplicit |
Definition at line 211 of file Lorentzian1D.h.
|
inline |
Definition at line 213 of file Lorentzian1D.h.
|
inline |
Definition at line 215 of file Lorentzian1D.h.
|
inline |
Copy constructor (deep copy)
Definition at line 222 of file Lorentzian1D.h.
|
inline |
Definition at line 225 of file Lorentzian1D.h.
|
inlinevirtual |
Destructor.
Definition at line 235 of file Lorentzian1D.h.
|
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 247 of file Lorentzian1D.h.
|
inlinevirtual |
Reimplemented from casacore::Function< T, T >.
Definition at line 250 of file Lorentzian1D.h.
|
inlinevirtual |
Reimplemented from casacore::Function< T, T >.
Definition at line 254 of file Lorentzian1D.h.
|
virtual |
Evaluate the Lorentzian and its derivatives at x
.
|
inline |
Copy assignment (deep copy)
Definition at line 231 of file Lorentzian1D.h.