casa6

//# LimbDarkenedDiskShape.h: defines LimbDarkened Disk shape

//

//#  CASA - Common Astronomy Software Applications (http://casa.nrao.edu/)

//# Copyright (C) 2012

//# 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 Lesser General Public License as published by

//# the Free Software Foundation; either version 2.1 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 Lesser General Public

//# License for more details.

//#

//# You should have received a copy of the GNU Lesser General Public License

//# along with this library; if not, write to the Free Software Foundation,

//# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

//#

//#

//#

//# $Id$

​

#ifndef COMPONENT_LIMBDARKENED_DISKSHAPE_H

#define COMPONENT_LIMBDARKENED_DISKSHAPE_H

​

//#! Includes go here

#include <casacore/casa/aips.h>

#include <casacore/casa/BasicSL/Complex.h>

#include <components/ComponentModels/TwoSidedShape.h>

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

​

namespace casacore{

​

class MDirection;

class MVAngle;

template <class Qtype> class Quantum;

​

}

​

namespace casa { //# NAMESPACE CASA - BEGIN

​

//# Forward Declarations

​

// <summary>A limb-darkened disk model for the spatial distribution of emission</summary>

​

//<use visibility=export>

​

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

// </reviewed>

​

// <prerequisite>

//   <li><linkto class=TwoSidedShape>TwoSidedShape</linkto>

// </prerequisite>

//

// <etymology>

//#! Except when it is obvious (e.g., "casacore::Array") explain how the class name

//#! expresses the role of this class.  Example: casacore::IPosition is short for

//#! "Integral Position" - a specialized integer vector for specifying

//#! array dimensions and indices.

// </etymology>

//

// <synopsis>

// A LimbDarkenedDiskShape models the spatial distribution of radiation from 

// the sky as a using a limb-darkened elliptical disk with user specified major axis

// width, minor axis width and position angle.

//

// This class like the other component shapes becomes more useful when used

// through the <linkto class=SkyComponent>SkyComponent</linkto> class, which

// incorperates the flux and spectral variation of the emission, or through the

// <linkto class=ComponentList>ComponentList</linkto> class, which handles

// groups of SkyComponent objects.

// 

// The functionality of this class is similar to that of <linkto class=DiskShape>

// DiskShape</linkto> with an additional parameter to describe the exponent in 

// the limb darkened disk model (\f$I=I_{0}(1-(r/R)^{2})^{n/2}\f$). 

//

// </synopsis>

//

// <example>

//#! One or two concise (~10-20 lines) examples, with a modest amount of

//#! text to support code fragments.  Use <srcblock> and </srcblock> to

//#! delimit example code.

// </example>

//

// <motivation>

//#! Insight into a class is often provided by a description of

//#! the circumstances that led to its conception and design.  Describe

//#! them here.

// </motivation>