casa6

​

//# ImageFit1D.h: Class to fit profiles to vectors from images

//# Copyright (C) 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: ImageFit1D.h 20229 2008-01-29 15:19:06Z gervandiepen $

​

#ifndef IMAGES_IMAGEFIT1D_H

#define IMAGES_IMAGEFIT1D_H

​

//# Includes

#include <casacore/casa/aips.h>

#include <casacore/casa/Arrays/Vector.h>

#include <casacore/scimath/Mathematics/NumericTraits.h>

#include <casacore/measures/Measures/MDirection.h>

#include <casacore/measures/Measures/MFrequency.h>

#include <casacore/measures/Measures/MDoppler.h>

#include <casacore/coordinates/Coordinates/CoordinateSystem.h>

#include <components/SpectralComponents/ProfileFit1D.h>

​

#include <memory>

​

namespace casacore{

​

class ImageRegion;

template<class T> class ImageInterface;

}

​

namespace casa {

​

class SpectralElement;

class SpectralList;

​

​

// <summary>

// Fit spectral components to a casacore::Vector of data from an image

// </summary>

​

// <use visibility=export>

​

// <reviewed reviewer="" date="" tests="tImageFit1D.cc">

// </reviewed>

​

// <prerequisite>

//   <li> <linkto class="SpectralElement">SpectralElement</linkto> 

//   <li> <linkto class="SpectralList">SpectralList</linkto> 

//   <li> <linkto class="SpectralFit">SpectralFit</linkto> 

//   <li> <linkto class="ProfileFit1D">ProfileFit1D</linkto> 

// </prerequisite>

​

// <synopsis> 

// Fit lists (held in class SpectralList) of SpectralElements to a casacore::Vector of data 

// from the image.  Each SpectralElement can  be one from a variety of types.

// The values of the parameters for each SpectralElement provide the initial 

// starting guesses for the fitting process.  

//

// You specify the domain in which the fit is to be done via the 

// enum AbcissaType.  The casacore::CoordinateSystem in the image is used

// to convert the pixel coordinates to the desired abcissa.  

// You can change the units of the casacore::CoordinateSystem if you want

// to fit in different units.  If you set an estimate yourself

// (function setElements or addElement) it is the callers responsibility

// that the elements are in the correct abcissa domain.  Function

// setGaussianElements will automatically make an estimate in the 

// correct domain.

//

// Also, a SpectralElement object holds a mask indicating whether 

// a parameter should be held fixed or solved for.   After the 

// fitting is done, a new SpectralList holding SpectralElements with 

// the fitted parameters is created.