Describes the function most often used for determining spectral index plus higher order terms: y = c_0 * x**(c_1 + c_2*ln(x) + c_3*ln(x)**2 +...) where c_1 is the traditional spectral index (alpha). More...

#include <PowerLogPolynomialSpectralElement.h>

Inheritance diagram for casa::PowerLogPolynomialSpectralElement:

Public Member Functions
	PowerLogPolynomialSpectralElement (casacore::uInt n)

*	PowerLogPolynomialSpectralElement (const casacore::Vector< casacore::Double > &param)
	Construct with the given parameters. More...

	PowerLogPolynomialSpectralElement (const PowerLogPolynomialSpectralElement &other)
	Copy constructor (deep copy) More...

	~PowerLogPolynomialSpectralElement ()

PowerLogPolynomialSpectralElement &	operator= (const PowerLogPolynomialSpectralElement &other)

SpectralElement *	clone () const

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 the function most often used for determining spectral index plus higher order terms: y = c_0 * x**(c_1 + c_2*ln(x) + c_3*ln(x)**2 +...) where c_1 is the traditional spectral index (alpha).

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd
Test programs:: tSpectralFit

Prerequisite

SpectralElement module

Etymology

From power law, logarithm, and polynomial and spectral line and element

Synopsis

Describes a function that can be used to fit for spectral index and higher order terms

Example

Motivation

To have a spectral element representing a spectral index function.

Definition at line 68 of file PowerLogPolynomialSpectralElement.h.

Constructor & Destructor Documentation

casa::PowerLogPolynomialSpectralElement::PowerLogPolynomialSpectralElement ( casacore::uInt n )

explicit

* casa::PowerLogPolynomialSpectralElement::PowerLogPolynomialSpectralElement ( const casacore::Vector< casacore::Double > & param )

Construct with the given parameters.

See above constructor for order in which the parameters should be supplied.

casa::PowerLogPolynomialSpectralElement::PowerLogPolynomialSpectralElement ( const PowerLogPolynomialSpectralElement & other )

Copy constructor (deep copy)

casa::PowerLogPolynomialSpectralElement::~PowerLogPolynomialSpectralElement ( )

Member Function Documentation

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

virtual

Implements casa::SpectralElement.

PowerLogPolynomialSpectralElement& casa::PowerLogPolynomialSpectralElement::operator= ( const PowerLogPolynomialSpectralElement & other )

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

casa/code/components/SpectralComponents/PowerLogPolynomialSpectralElement.h

Public Member Functions

Additional Inherited Members