Describes a single Lorentzian spectral profile. More...

#include <LorentzianSpectralElement.h>

Inheritance diagram for casa::LorentzianSpectralElement:

Public Member Functions
	LorentzianSpectralElement ()
	has amp = 1, center = 0, and fwhm = 1
	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)
Double	operator() (const Double x) const
	Evaluate the value of the profile at x.
Double	getIntegral () const
	get the integral of the function

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 ( )

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

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 ( )

Member Function Documentation

SpectralElement* casa::LorentzianSpectralElement::clone ( ) const [virtual]

Implements casa::SpectralElement.

Double casa::LorentzianSpectralElement::getIntegral ( ) const [virtual]

get the integral of the function

Implements casa::PCFSpectralElement.

Double casa::LorentzianSpectralElement::operator() ( const Double x ) const [virtual]

Evaluate the value of the profile at x.