casa::LorentzianSpectralElement Class Reference

Describes a single Lorentzian spectral profile. More...

#include <LorentzianSpectralElement.h>

Inheritance diagram for casa::LorentzianSpectralElement:

List of all members.

Public Member Functions
	LorentzianSpectralElement (const Double ampl, const Double center, const Double fwhm)
	Construct with given type and values.
	LorentzianSpectralElement (const Vector< Double > &param)
	LorentzianSpectralElement (const LorentzianSpectralElement &other)
	Copy constructor (deep copy).
	~LorentzianSpectralElement ()
SpectralElement *	clone () const
LorentzianSpectralElement &	operator= (const LorentzianSpectralElement &other)
	Assignment (copy semantics).
void	setFWHM (Double fwhm)
Double	getFWHM () const
Double	getFWHMErr () const
Double	getIntegral () const
	get the integral of the function
Private Member Functions
	LorentzianSpectralElement ()
	has amp = 1, center = 0, and fwhm = 1

---

Detailed Description

Describes a single Lorentzian spectral profile.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Test programs:

tSpectralFit

Prerequisite

• SpectralElement module

Etymology

From Lorentzian and spectral profile and element

Synopsis

The LorentzianSpectralElement class describes a Lorentzian spectral profile.

Example

Motivation

To have a container for data descrbing a Lorentzian spectral profile for fitting to an observed spectrum

Definition at line 63 of file LorentzianSpectralElement.h.

---

Constructor & Destructor Documentation

casa::LorentzianSpectralElement::LorentzianSpectralElement	(	const Double	ampl,
		const Double	center,
		const Double	fwhm
	)

Construct with given type and values.

Thrown Exceptions

• AipsError if fwhm == 0.0 or amp == 0.0

casa::LorentzianSpectralElement::LorentzianSpectralElement

(

const Vector< Double > &

param

)

casa::LorentzianSpectralElement::LorentzianSpectralElement

(

const LorentzianSpectralElement &

other

)

Copy constructor (deep copy).

casa::LorentzianSpectralElement::~LorentzianSpectralElement

(

)

casa::LorentzianSpectralElement::LorentzianSpectralElement

(

)

[private]

has amp = 1, center = 0, and fwhm = 1

---

Member Function Documentation

SpectralElement* casa::LorentzianSpectralElement::clone

(

)

const [virtual]

Implements casa::SpectralElement.

Double casa::LorentzianSpectralElement::getFWHM

(

)

const [inline, virtual]

Implements casa::PCFSpectralElement.

Definition at line 91 of file LorentzianSpectralElement.h.

References casa::PCFSpectralElement::getWidth().

Double casa::LorentzianSpectralElement::getFWHMErr

(

)

const [inline, virtual]

Implements casa::PCFSpectralElement.

Definition at line 93 of file LorentzianSpectralElement.h.

References casa::PCFSpectralElement::getWidthErr().

Double casa::LorentzianSpectralElement::getIntegral

(

)

const [virtual]

get the integral of the function

Implements casa::PCFSpectralElement.

LorentzianSpectralElement& casa::LorentzianSpectralElement::operator=

(

const LorentzianSpectralElement &

other

)

Assignment (copy semantics).

Reimplemented from casa::SpectralElement.

void casa::LorentzianSpectralElement::setFWHM

(

Double

fwhm

)

[inline]

Definition at line 89 of file LorentzianSpectralElement.h.

References casa::PCFSpectralElement::setWidth().

---

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

• code/components/SpectralComponents/LorentzianSpectralElement.h