source: trunk/external-alma/components/SpectralComponents/PolynomialSpectralElement.h@ 2995

//# SpectralElement.h: Describes (a set of related) spectral lines
//# Copyright (C) 2001,2003,2004
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//#
//# $Id: PolynomialSpectralElement.h 21451 2014-06-10 07:48:08Z gervandiepen $

#ifndef COMPONENTS_POLYNOMIALSPECTRALELEMENT_H
#define COMPONENTS_POLYNOMIALSPECTRALELEMENT_H

#include <components/SpectralComponents/SpectralElement.h>

namespace casa { //# NAMESPACE CASA - BEGIN

// <summary>
// Describes a polynomial spectral profile
// </summary>

// <use visibility=export>

// <reviewed reviewer="" date="yyyy/mm/dd" tests="tSpectralFit" demos="">
// </reviewed>

// <prerequisite>
//   <li> <linkto class=SpectralElement>SpectralElement</linkto> module
// </prerequisite>
//
// <etymology>
// From polynomial and spectral line and element
// </etymology>
//
// <synopsis>
// The PolynomialSpectralElement class describes a polynomial spectral profile.

// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// To have a container for data describing a polynomial spectral profile for fitting to an observed spectrum
// </motivation>


class PolynomialSpectralElement: public SpectralElement {
public:

        // Useless constructor for anythong but allocating memory in a Vector etc
        PolynomialSpectralElement();


        // Construct an n-degree polynomial
        explicit PolynomialSpectralElement(const uInt n);

        // Construct the given tp with the given param
        // <thrown>
        //   <li> AipsError if incorrect number of parameters (e.g. not 3 for GAUSSIAN)
        //   <li> AipsError if sigma == 0.0
        // </thrown>
        PolynomialSpectralElement(const Vector<Double> &param);
        // Copy constructor (deep copy)
        // <thrown>
        //   <li> AipsError if sigma == 0.0
        // </thrown>
        PolynomialSpectralElement(const PolynomialSpectralElement &other);

        ~PolynomialSpectralElement();

        SpectralElement* clone() const;

        // Get the degree of polynomial
        uInt getDegree() const;

};

//# Global functions
// <summary> Global functions </summary>
// <group name=Output>
// Output declaration
ostream &operator<<(ostream &os, const PolynomialSpectralElement &elem);
// </group>


} //# NAMESPACE CASA - END

#endif