casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
casa::PolynomialSpectralElement Class Reference

Describes a polynomial spectral profile. More...

#include <PolynomialSpectralElement.h>

Inheritance diagram for casa::PolynomialSpectralElement:
casa::SpectralElement

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 ()
SpectralElementclone () const
PolynomialSpectralElementoperator= (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

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

Construct an n-degree polynomial.

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

Copy constructor (deep copy)

Thrown Exceptions


Member Function Documentation

Implements casa::SpectralElement.

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: