casa::PolynomialSpectralElement Class Reference

Describes a polynomial spectral profile. More...

#include <PolynomialSpectralElement.h>

Inheritance diagram for casa::PolynomialSpectralElement:

Public Member Functions
	PolynomialSpectralElement ()
	Useless constructor for anythong but allocating memory in a casacore::Vector etc. More...
	PolynomialSpectralElement (const casacore::uInt n)
	Construct an n-degree polynomial. More...
	PolynomialSpectralElement (const casacore::Vector< casacore::Double > &param)
	Construct the given tp with the given param. More...
	PolynomialSpectralElement (const PolynomialSpectralElement &other)
	Copy constructor (deep copy) More...
	~PolynomialSpectralElement ()
SpectralElement *	clone () const
casacore::uInt	getDegree () const
	Get the degree of polynomial. More...
Public Member Functions inherited from casa::SpectralElement
virtual	~SpectralElement ()
virtual casacore::Double	operator() (const casacore::Double x) const
	Evaluate the value of the element at x. More...
casacore::Bool	operator== (const SpectralElement &other) const
virtual casacore::Double	operator[] (const casacore::uInt n) const
	Get parameter n. More...
SpectralElement::Types	getType () const
	Get type of this element. More...
void	get (casacore::Vector< casacore::Double > &params) const
	Get all parameters. More...
casacore::Vector < casacore::Double >	get () const
void	getError (casacore::Vector< casacore::Double > &err) const
	Get error estimates of parameters. More...
casacore::Vector < casacore::Double >	getError () const
casacore::uInt	getOrder () const
	Get the order (i.e. More...
virtual void	setError (const casacore::Vector< casacore::Double > &err)
	Set the error fields. More...
virtual void	fix (const casacore::Vector< casacore::Bool > &fix)
	Set fixed parameters (true) or unset them (false) More...
const casacore::Vector < casacore::Bool > &	fixed () const
	Get the fix state[s]. More...
virtual casacore::Bool	toRecord (casacore::RecordInterface &out) const
	Save to a record. More...
virtual void	set (const casacore::Vector< casacore::Double > &params)
	set parameters More...

Additional Inherited Members
Public Types inherited from casa::SpectralElement
enum	Types {   GAUSSIAN,   POLYNOMIAL,   COMPILED,   GMULTIPLET,   LORENTZIAN,   POWERLOGPOLY,   LOGTRANSPOLY,   N_Types }
	Supported spectral components. More...
Static Public Member Functions inherited from casa::SpectralElement
static const casacore::String *	allTypes (casacore::Int &nall, const SpectralElement::Types *&typ)
	Get all the types available as casacore::String and codes, and number available. More...
static const casacore::String &	fromType (SpectralElement::Types tp)
	Get a string from the type. More...
static casacore::Bool	toType (SpectralElement::Types &tp, const casacore::String &typName)
	Get a type from a (non-case sensitive; minimum match) String. More...
Protected Member Functions inherited from casa::SpectralElement
	SpectralElement ()
	SpectralElement (Types type, const casacore::Vector< casacore::Double > &parms=casacore::Vector< casacore::Double >(0))
	SpectralElement (const SpectralElement &other)
SpectralElement &	operator= (const SpectralElement &other)
void	_set (const casacore::Vector< casacore::Double > &params)
void	_setType (const Types type)
void	_setFunction (const std::shared_ptr< casacore::Function< casacore::Double, casacore::Double > > &f)
virtual std::shared_ptr < casacore::Function < casacore::Double, casacore::Double > >	_getFunction () const

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

(

)

Useless constructor for anythong but allocating memory in a casacore::Vector etc.

casa::PolynomialSpectralElement::PolynomialSpectralElement ( const casacore::uInt  n )

explicit

Construct an n-degree polynomial.

casa::PolynomialSpectralElement::PolynomialSpectralElement

(

const casacore::Vector< casacore::Double > &

param

)

Construct the given tp with the given param.

Thrown Exceptions

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

casa::PolynomialSpectralElement::PolynomialSpectralElement

(

const PolynomialSpectralElement &

other

)

Copy constructor (deep copy)

Thrown Exceptions

• casacore::AipsError if sigma == 0.0

casa::PolynomialSpectralElement::~PolynomialSpectralElement

(

)

Member Function Documentation

SpectralElement* casa::PolynomialSpectralElement::clone ( ) const

virtual

Implements casa::SpectralElement.

casacore::uInt casa::PolynomialSpectralElement::getDegree

(

)

const

Get the degree of polynomial.

---

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

• casa/code/components/SpectralComponents/PolynomialSpectralElement.h