casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
casa::CompiledSpectralElement Class Reference

Describes a compiled function for describing a spectral profile. More...

#include <CompiledSpectralElement.h>

Inheritance diagram for casa::CompiledSpectralElement:
casa::SpectralElement casa::GaussianMultipletSpectralElement

Public Member Functions

 CompiledSpectralElement (const casacore::String &function, const casacore::Vector< casacore::Double > &param)
 Construct a compiled string. More...
 CompiledSpectralElement (const CompiledSpectralElement &other)
virtual ~CompiledSpectralElement ()
SpectralElementclone () const
CompiledSpectralElementoperator= (const CompiledSpectralElement &other)
virtual casacore::Double operator() (const casacore::Double x) const
 Evaluate the value of the element at x. More...
*const casacore::StringgetFunction () const
 Get the string of a compiled functional. More...
- Public Member Functions inherited from casa::SpectralElement
virtual ~SpectralElement ()
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::Double
get () const
void getError (casacore::Vector< casacore::Double > &err) const
 Get error estimates of parameters. More...
< 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 {
 Supported spectral components. More...
- Static Public Member Functions inherited from casa::SpectralElement
static const casacore::StringallTypes (casacore::Int &nall, const SpectralElement::Types *&typ)
 Get all the types available as casacore::String and codes, and number available. More...
static const casacore::StringfromType (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)
SpectralElementoperator= (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 compiled function for describing a spectral profile.

Intended use:

Public interface

Review Status

Date Reviewed:
Test programs:



From compiled and spectral line and element


The CompiledSpectralElement class describes a compiled function for describing spectral profile.



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

Definition at line 66 of file CompiledSpectralElement.h.

Constructor & Destructor Documentation

casa::CompiledSpectralElement::CompiledSpectralElement ( const casacore::String function,
const casacore::Vector< casacore::Double > &  param 

Construct a compiled string.

casa::CompiledSpectralElement::CompiledSpectralElement ( const CompiledSpectralElement other)
virtual casa::CompiledSpectralElement::~CompiledSpectralElement ( )

Member Function Documentation

SpectralElement* casa::CompiledSpectralElement::clone ( ) const
* const casacore::String& casa::CompiledSpectralElement::getFunction ( ) const

Get the string of a compiled functional.

virtual casacore::Double casa::CompiledSpectralElement::operator() ( const casacore::Double  x) const

Evaluate the value of the element at x.

Reimplemented from casa::SpectralElement.

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

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