casa::PolynomialSpectralElement Class Reference

Describes a polynomial spectral profile. More...

#include <PolynomialSpectralElement.h>

Inheritance diagram for casa::PolynomialSpectralElement:

List of all members.

Public Member Functions
	PolynomialSpectralElement (const uInt n)
	Construct an n-degree polynomial.
	PolynomialSpectralElement (const Vector< Double > &param)
	Construct the given tp with the given param.
	PolynomialSpectralElement (const PolynomialSpectralElement &other)
	Copy constructor (deep copy)
	~PolynomialSpectralElement ()
SpectralElement *	clone () const
PolynomialSpectralElement &	operator= (const PolynomialSpectralElement &other)
Double	operator() (const Double x) const
	Evaluate the value of the element at x.
uInt	getDegree () const
	Get the degree of polynomial.

---

Detailed Description

Describes a polynomial spectral profile.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Test programs:

tSpectralFit

Prerequisite

• SpectralElement module

Etymology

From polynomial and spectral line and element

Synopsis

The PolynomialSpectralElement class describes a polynomial spectral profile.

Example

Motivation

To have a container for data describing a polynomial spectral profile for fitting to an observed spectrum

Definition at line 66 of file PolynomialSpectralElement.h.

---

Constructor & Destructor Documentation

casa::PolynomialSpectralElement::PolynomialSpectralElement

(

const uInt

n

)

[explicit]

Construct an n-degree polynomial.

casa::PolynomialSpectralElement::PolynomialSpectralElement

(

const Vector< Double > &

param

)

Construct the given tp with the given param.

Thrown Exceptions

• AipsError if incorrect number of parameters (e.g. not 3 for GAUSSIAN)
• AipsError if sigma == 0.0

casa::PolynomialSpectralElement::PolynomialSpectralElement

(

const PolynomialSpectralElement &

other

)

Copy constructor (deep copy)

Thrown Exceptions

• AipsError if sigma == 0.0

casa::PolynomialSpectralElement::~PolynomialSpectralElement

(

)

---

Member Function Documentation

SpectralElement* casa::PolynomialSpectralElement::clone

(

)

const [virtual]

Implements casa::SpectralElement.

uInt casa::PolynomialSpectralElement::getDegree

(

)

const

Get the degree of polynomial.

Double casa::PolynomialSpectralElement::operator()

(

const Double

x

)

const [virtual]

Evaluate the value of the element at x.

Implements casa::SpectralElement.

PolynomialSpectralElement& casa::PolynomialSpectralElement::operator=

(

const PolynomialSpectralElement &

other

)

---

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

• casacore/components/SpectralComponents/PolynomialSpectralElement.h