casa::PCFSpectralElement Class Reference

Abstract base class that describes a spectral profile that can be parameterized by a peak value (amplitude), center, and FWHM. More...

#include <PCFSpectralElement.h>

Inheritance diagram for casa::PCFSpectralElement:

List of all members.

Public Member Functions
virtual	~PCFSpectralElement ()
	Destructor.
Double	getAmpl () const
	PCFSpectralElement& operator=(const PCFSpectralElement &other);.
Double	getCenter () const
	Get center value.
virtual Double	getFWHM () const
	Get the width.
virtual Double	getIntegral () const =0
	get the integral from -inf to inf
Double	getAmplErr () const
	Get amplitude error estimate.
Double	getCenterErr () const
	Get center value error estimate.
virtual Double	getFWHMErr () const
	Get the width error estimate.
virtual Double	getIntegralErr () const
void	set (const Vector< Double > &param)
	Get error estimates of parameters.
void	setAmpl (const Double ampl)
void	setCenter (const Double center)
virtual void	setFWHM (const Double fwhm)
void	fixAmpl (const Bool fix=True)
void	fixCenter (const Bool fix=True)
void	fixFWHM (const Bool fix=True)
void	fixByString (const String &s)
	fix parameters via encoded string.

---

Detailed Description

Abstract base class that describes a spectral profile that can be parameterized by a peak value (amplitude), center, and FWHM.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Test programs:

tSpectralFit

Prerequisite

• SpectralElement module

Etymology

From p(eak), c(enter), f(whm), and spectral line and element

Synopsis

Abstract base class that describes a spectral profile that can be parameterized by a peak value (amplitude), center, and FWHM.

Example

Motivation

To have a class containing common methods for things like Gaussian, Lorentzian, and Voigt profiles.

Definition at line 66 of file PCFSpectralElement.h.

---

Constructor & Destructor Documentation

virtual casa::PCFSpectralElement::~PCFSpectralElement

(

)

[virtual]

Destructor.

---

Member Function Documentation

void casa::PCFSpectralElement::fixAmpl

(

const Bool

fix = True

)

void casa::PCFSpectralElement::fixByString

(

const String &

s

)

fix parameters via encoded string.

If s contains a, fix amplitude. If s contains f, fix fwhm. If s contains c, fix center.

void casa::PCFSpectralElement::fixCenter

(

const Bool

fix = True

)

void casa::PCFSpectralElement::fixFWHM

(

const Bool

fix = True

)

Double casa::PCFSpectralElement::getAmpl

(

)

const

PCFSpectralElement& operator=(const PCFSpectralElement &other);.

Get amplitude

Double casa::PCFSpectralElement::getAmplErr

(

)

const

Get amplitude error estimate.

Double casa::PCFSpectralElement::getCenter

(

)

const

Get center value.

Double casa::PCFSpectralElement::getCenterErr

(

)

const

Get center value error estimate.

virtual Double casa::PCFSpectralElement::getFWHM

(

)

const [virtual]

Get the width.

Reimplemented in casa::GaussianSpectralElement.

virtual Double casa::PCFSpectralElement::getFWHMErr

(

)

const [virtual]

Get the width error estimate.

Reimplemented in casa::GaussianSpectralElement.

virtual Double casa::PCFSpectralElement::getIntegral

(

)

const [pure virtual]

get the integral from -inf to inf

Implemented in casa::GaussianSpectralElement, and casa::LorentzianSpectralElement.

virtual Double casa::PCFSpectralElement::getIntegralErr

(

)

const [virtual]

void casa::PCFSpectralElement::set

(

const Vector< Double > &

param

)

[virtual]

Get error estimates of parameters.

Reimplemented from casa::SpectralElement.

void casa::PCFSpectralElement::setAmpl

(

const Double

ampl

)

void casa::PCFSpectralElement::setCenter

(

const Double

center

)

virtual void casa::PCFSpectralElement::setFWHM

(

const Double

fwhm

)

[virtual]

Reimplemented in casa::GaussianSpectralElement.

---

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

• casacore/components/SpectralComponents/PCFSpectralElement.h