casa::PCFSpectralElement Class Reference

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

#include <PCFSpectralElement.h>

Inheritance diagram for casa::PCFSpectralElement:

List of all members.

Public Types
enum	ParamType {   AMP,   CENTER,   WIDTH }
	to help avoid having to hard code parameter indices More...
Public Member Functions
virtual	~PCFSpectralElement ()
	Destructor.
Double	getAmpl () const
	PCFSpectralElement& operator=(const PCFSpectralElement &other);.
Double	getCenter () const
	Get center value.
virtual Double	getWidth () const
	Get the width.
virtual Double	getFWHM () const =0
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	getWidthErr () const
	Get the width error estimate.
virtual Double	getFWHMErr () const =0
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	setWidth (const Double width)
void	fixAmpl (const Bool fix=True)
void	fixCenter (const Bool fix=True)
void	fixWidth (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 width.

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 width.

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.

---

Member Enumeration Documentation

enum casa::PCFSpectralElement::ParamType

to help avoid having to hard code parameter indices

Enumerator:

AMP
CENTER
WIDTH

Definition at line 70 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 width. If s contains c, fix center.

void casa::PCFSpectralElement::fixCenter

(

const Bool

fix = True

)

void casa::PCFSpectralElement::fixFWHM

(

const Bool

fix = True

)

[inline]

Definition at line 122 of file PCFSpectralElement.h.

References casa::SpectralElement::fix(), and fixWidth().

void casa::PCFSpectralElement::fixWidth

(

const Bool

fix = True

)

Referenced by fixFWHM().

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 [pure virtual]

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

virtual Double casa::PCFSpectralElement::getFWHMErr

(

)

const [pure virtual]

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

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]

virtual Double casa::PCFSpectralElement::getWidth

(

)

const [virtual]

Get the width.

Referenced by casa::LorentzianSpectralElement::getFWHM().

virtual Double casa::PCFSpectralElement::getWidthErr

(

)

const [virtual]

Get the width error estimate.

Referenced by casa::LorentzianSpectralElement::getFWHMErr().

void casa::PCFSpectralElement::set

(

const Vector< Double > &

param

)

[virtual]

Get error estimates of parameters.

Reimplemented from casa::SpectralElement.

Reimplemented in casa::GaussianSpectralElement.

void casa::PCFSpectralElement::setAmpl

(

const Double

ampl

)

void casa::PCFSpectralElement::setCenter

(

const Double

center

)

virtual void casa::PCFSpectralElement::setWidth

(

const Double

width

)

[virtual]

Referenced by casa::LorentzianSpectralElement::setFWHM().

---

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

• code/components/SpectralComponents/PCFSpectralElement.h