Документ взят из кэша поисковой машины. Адрес
оригинального документа
: http://www.atnf.csiro.au/computing/software/casacore/casacore-1.2.0/doc/html/classcasa_1_1Gaussian1DParam.html
Дата изменения: Unknown Дата индексирования: Mon Feb 14 22:38:02 2011 Кодировка: Поисковые слова: hst |
Parameter handling for one dimensional Gaussian class. More...
#include <Gaussian1DParam.h>
Public Types | |
enum | { HEIGHT, CENTER, WIDTH } |
Public Member Functions | |
Gaussian1DParam () | |
Constructs the one dimensional Gaussians. | |
Gaussian1DParam (const T &height) | |
Gaussian1DParam (const T &height, const T ¢er) | |
Gaussian1DParam (const T &height, const T ¢er, const T &width) | |
Gaussian1DParam (const Gaussian1DParam< T > &other) | |
Copy constructor (deep copy). | |
template<class W > | |
Gaussian1DParam (const Gaussian1DParam< W > &other) | |
Gaussian1DParam< T > & | operator= (const Gaussian1DParam< T > &other) |
Copy assignment (deep copy). | |
virtual | ~Gaussian1DParam () |
Destructor. | |
virtual const String & | name () const |
Give name of function. | |
T | height () const |
Get or set the peak height of the Gaussian. | |
void | setHeight (const T &height) |
T | flux () const |
Get or set the analytical integrated area underneath the Gaussian. | |
void | setFlux (const T &flux) |
T | center () const |
Get or set the center ordinate of the Gaussian. | |
void | setCenter (const T &cnter) |
T | width () const |
Get or set the FWHM of the Gaussian. | |
void | setWidth (const T &width) |
Protected Attributes | |
T | fwhm2int |
Constant to scale halfwidth at 1/e to FWHM. |
Parameter handling for one dimensional Gaussian class.
Internal
A 1-dimensional Gaussian's parameters.
A Gaussian1D
is described by a height, center, and width. The parameters (height, center and width) may be changed at run time.
The width of the Gaussian (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 Gaussian 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 Gaussian. 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 Gaussian 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 FunctionParam class), is used to provide an interface to the Fitting classes.
There are 3 parameters that are used to describe the Gaussian:
height()
member function. center()
member 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.
This class is in general used implicitly by the Gaussian1D
class only.
Gaussian1D<Double> gf(5.0, 25.0, 7); gf(25); // = 5.0 gf.setHeight(1.0); gf[WIDTH](2.0); gf[CENTER](0.0); gf(1); // = 0.5*height = 0.5
Definition at line 128 of file Gaussian1DParam.h.
anonymous enum |
Definition at line 131 of file Gaussian1DParam.h.
casa::Gaussian1DParam< T >::Gaussian1DParam | ( | ) |
Constructs the one dimensional Gaussians.
Defaults: height=1, center=0, width(FWHM)=1.
Warning: Could not use default arguments that worked both with gcc and IRIX and all templates
casa::Gaussian1DParam< T >::Gaussian1DParam | ( | const T & | height | ) | [explicit] |
casa::Gaussian1DParam< T >::Gaussian1DParam | ( | const T & | height, | |
const T & | center | |||
) |
casa::Gaussian1DParam< T >::Gaussian1DParam | ( | const T & | height, | |
const T & | center, | |||
const T & | width | |||
) |
casa::Gaussian1DParam< T >::Gaussian1DParam | ( | const Gaussian1DParam< T > & | other | ) |
Copy constructor (deep copy).
casa::Gaussian1DParam< T >::Gaussian1DParam | ( | const Gaussian1DParam< W > & | other | ) | [inline] |
Definition at line 149 of file Gaussian1DParam.h.
virtual casa::Gaussian1DParam< T >::~Gaussian1DParam | ( | ) | [virtual] |
Destructor.
T casa::Gaussian1DParam< T >::center | ( | ) | const [inline] |
Get or set the center ordinate of the Gaussian.
Definition at line 181 of file Gaussian1DParam.h.
T casa::Gaussian1DParam< T >::flux | ( | ) | const |
Get or set the analytical integrated area underneath the Gaussian.
Use these functions as an alternative to the height functions.
T casa::Gaussian1DParam< T >::height | ( | ) | const [inline] |
Get or set the peak height of the Gaussian.
Definition at line 168 of file Gaussian1DParam.h.
virtual const String& casa::Gaussian1DParam< T >::name | ( | ) | const [inline, virtual] |
Give name of function.
Reimplemented from casa::Function< T, T >.
Definition at line 163 of file Gaussian1DParam.h.
Gaussian1DParam<T>& casa::Gaussian1DParam< T >::operator= | ( | const Gaussian1DParam< T > & | other | ) |
Copy assignment (deep copy).
void casa::Gaussian1DParam< T >::setCenter | ( | const T & | cnter | ) | [inline] |
Definition at line 182 of file Gaussian1DParam.h.
void casa::Gaussian1DParam< T >::setFlux | ( | const T & | flux | ) |
void casa::Gaussian1DParam< T >::setHeight | ( | const T & | height | ) | [inline] |
Definition at line 169 of file Gaussian1DParam.h.
void casa::Gaussian1DParam< T >::setWidth | ( | const T & | width | ) | [inline] |
Definition at line 188 of file Gaussian1DParam.h.
T casa::Gaussian1DParam< T >::width | ( | ) | const [inline] |
Get or set the FWHM of the Gaussian.
Definition at line 187 of file Gaussian1DParam.h.
T casa::Gaussian1DParam< T >::fwhm2int [protected] |
Constant to scale halfwidth at 1/e to FWHM.
static const T fwhm2int;
Definition at line 188 of file Gaussian1DParam.h.