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

A one dimensional Lorentzian class. More...

#include <Lorentzian1D.h>

Inheritance diagram for casacore::Lorentzian1D< T >:
casacore::Lorentzian1DParam< T > casacore::Function1D< T > casacore::Function< T, U > casacore::Functional< FunctionTraits< T >::ArgType, U > casacore::Functional< Vector< FunctionTraits< T >::ArgType >, U >

Public Member Functions

 Lorentzian1D ()
 Constructs the one dimensional Lorentzians. More...
 
 Lorentzian1D (const T &height)
 
 Lorentzian1D (const T &height, const T &center)
 
 Lorentzian1D (const T &height, const T &center, const T &width)
 
 Lorentzian1D (const Lorentzian1D< T > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 Lorentzian1D (const Lorentzian1D< W > &other)
 
Lorentzian1D< T > & operator= (const Lorentzian1D< T > &other)
 Copy assignment (deep copy) More...
 
virtual ~Lorentzian1D ()
 Destructor. More...
 
virtual T eval (typename Function1D< T >::FunctionArg x) const
 Evaluate the Lorentzian at x. More...
 
virtual Function< T > * clone () const
 Return a copy of this object from the heap. More...
 
virtual Function< typename
FunctionTraits< T >::DiffType > * 
cloneAD () const
 
virtual Function< typename
FunctionTraits< T >::BaseType > * 
cloneNonAD () const
 
- Public Member Functions inherited from casacore::Lorentzian1DParam< T >
 Lorentzian1DParam ()
 Constructs the one dimensional Lorentzians. More...
 
 Lorentzian1DParam (const T &height)
 
 Lorentzian1DParam (const T &height, const T &center)
 
 Lorentzian1DParam (const T &height, const T &center, const T &width)
 
 Lorentzian1DParam (const Lorentzian1DParam< T > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 Lorentzian1DParam (const Lorentzian1DParam< W > &other)
 
Lorentzian1DParam< T > & operator= (const Lorentzian1DParam< T > &other)
 Copy assignment (deep copy) More...
 
virtual ~Lorentzian1DParam ()
 Destructor. More...
 
virtual const Stringname () const
 Give name of function. More...
 
height () const
 Get or set the peak height of the Lorentzian. More...
 
void setHeight (const T &height)
 
flux () const
 Get or set the analytical integrated area underneath the Lorentzian. More...
 
void setFlux (const T &flux)
 
center () const
 Get or set the center ordinate of the Lorentzian. More...
 
void setCenter (const T &cnter)
 
width () const
 Get or set the FWHM of the Lorentzian. More...
 
void setWidth (const T &width)
 
- Public Member Functions inherited from casacore::Function1D< T >
 Function1D ()
 Constructors. More...
 
 Function1D (const uInt n)
 
 Function1D (const Vector< T > &in)
 
 Function1D (const FunctionParam< T > &other)
 
 Function1D (const Function1D< T, 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< T, U >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< T > &in)
 
 Function (const FunctionParam< T > &other)
 
template<class W , class X >
 Function (const Function< W, X > &other)
 
 Function (const Function< T, 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...
 
T & operator[] (const uInt n)
 Manipulate the nth parameter (0-based) with no index check. More...
 
const T & 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< T > & parameters () const
 Return the parameter interface. More...
 
FunctionParam< 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...
 
- Public Member Functions inherited from casacore::Functional< FunctionTraits< T >::ArgType, U >
virtual ~Functional ()
 Destructor. More...
 
virtual U operator() (const FunctionTraits< T >::ArgType &x) const =0
 Map a Domain x into a Range y value. More...
 
- Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< T >::ArgType >, U >
virtual ~Functional ()
 Destructor. More...
 
virtual U operator() (const Vector< FunctionTraits< T >::ArgType > &x) const =0
 Map a Domain x into a Range y value. More...
 

Additional Inherited Members

- Public Types inherited from casacore::Lorentzian1DParam< T >
enum  {
  HEIGHT,
  CENTER,
  WIDTH
}
 
- Public Types inherited from casacore::Function1D< T >
typedef const T * FunctionArg
 
- Public Types inherited from casacore::Function< T, U >
typedef FunctionTraits< T >
::ArgType 
ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Lorentzian1DParam< T >
fwhm2int
 Constant to scale halfwidth at 1/e to FWHM. More...
 
- Protected Attributes inherited from casacore::Function< T, U >
FunctionParam< 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< T >

A one dimensional Lorentzian class.

Intended use:

Public interface

Review Status

Reviewed By:
tcornwel
Date Reviewed:
1996/02/22
Test programs:
tLorentzian1D

Prerequisite

Etymology

A Lorentzian1D functional is designed exclusively for calculating a Lorentzian (or Normal) distribution in one dimension.

Synopsis

A Lorentzian1D is described by a height, center, and width. Its fundamental operation is evaluating itself at some x. The parameters (height, center and width) may be changed at run time.

The width of the Lorentzian (for the constructors or the setWidth function) is always specified in terms of the full width at half maximum (FWHM). It is always positive and attempts to set a non-positive width will throw an assertion when in debug mode.

The peak height of the Lorentzian can be specified at construction time or by using the setHeight function. Alternatively the setFlux function can be used to implicitly set the peak height by specifying the integrated area under the Lorentzian. The height (or flux) can be positive, negative or zero, as this class makes no assumptions on what quantity the height represents.


Tip: Changing the width of the Lorentzian will not affect its peak height but will change its flux; So you should always set the width before setting the flux;

The parameter interface (see Lorentzian1DParam class), is used to provide an interface to the Fitting classes.

There are 3 parameters that are used to describe the Lorentzian:

  1. The height of the Lorentzian. This is identical to the value returned using the height() member function.
  2. The center of the Lorentzian in the x direction. This is identical to the value returned using the center() member function.
  3. The width (FWHM) of the Lorentzian. To aid convergence of the non-linear fitting routines this parameter is allowed to be negative. This does not affect the shape of the Lorentzian as the square of the width is used when evaluating the function.

An enumeration for the HEIGHT, WIDTH and CENTER 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.

Example

Lorentzian<Double> gf(5.0, 25.0, 7);
gf(25); // = 5.0
gf[HEIGHT](1.0);
gf.setWidth(2.0);
gf[CENTER](0.0);
gf(1); // = 0.5*height = 0.5

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

Definition at line 136 of file Lorentzian1D.h.

Constructor & Destructor Documentation

template<class T>
casacore::Lorentzian1D< T >::Lorentzian1D ( )
inline

Constructs the one dimensional Lorentzians.

Defaults: height=1, center=0, width(FWHM)=1.
Warning: Could not use default arguments that worked both with gcc and IRIX

Definition at line 146 of file Lorentzian1D.h.

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

Definition at line 147 of file Lorentzian1D.h.

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

Definition at line 148 of file Lorentzian1D.h.

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

Definition at line 150 of file Lorentzian1D.h.

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

Copy constructor (deep copy)

Definition at line 156 of file Lorentzian1D.h.

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

Definition at line 158 of file Lorentzian1D.h.

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

Destructor.

Definition at line 166 of file Lorentzian1D.h.

Member Function Documentation

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

Definition at line 178 of file Lorentzian1D.h.

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

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

Definition at line 179 of file Lorentzian1D.h.

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

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

Definition at line 181 of file Lorentzian1D.h.

template<class T>
virtual T casacore::Lorentzian1D< T >::eval ( typename Function1D< T >::FunctionArg  x) const
virtual

Evaluate the Lorentzian at x.

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

Copy assignment (deep copy)

Definition at line 162 of file Lorentzian1D.h.

References casacore::Lorentzian1DParam< T >::operator=().


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