/usr/include/casacore/scimath/Functionals/Gaussian2DParam.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 | //# Gaussian2DParam.h: Parameter handling for 2 dimensional Gaussian class
//# Copyright (C) 2001,2002,2003
//# 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$
#ifndef SCIMATH_GAUSSIAN2DPARAM_H
#define SCIMATH_GAUSSIAN2DPARAM_H
#include <casacore/casa/aips.h>
#include <casacore/scimath/Functionals/Function.h>
#include <casacore/casa/BasicSL/String.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
template<class T> class Vector;
// <summary> Parameter handling for 2 dimensional Gaussian class
// </summary>
// <use visibility=local>
// <reviewed reviewer="mwieringa" date="1996/10/d24" tests="tGaussian2D">
// </reviewed>
// <prerequisite>
// <li> <linkto class="FunctionParam">FunctionParam</linkto> class
// <li> <linkto class="Function">Function</linkto> class
// </prerequisite>
// <etymology>
// A 2-dimensional Gaussian's parameters.
// </etymology>
// <synopsis>
// A <src>Gaussian2D</src> is described by a height, center, and width,
// and position angle.
// The width of the Gaussian (for the constructors or the <src> setWidth
// </src> function) is always specified in terms of the full width at half
// maximum (FWHM). The major axis is parallel with the y axis when the
// position angle is zero. The major axis will always have a larger width
// than the minor axis.
//
// It is not possible to set the width of the major axis (using the <src>
// setMajorAxis </src> function) smaller than the width of the current minor
// axis. Similarly it is not possible to set the width of the minor axis
// (using the <src> setMinorAxis </src> function) to be larger than the
// current major axis. Exceptions are thrown if these rules are violated or
// if either the major or minor axis is set to a non-positive width. To
// set both axis in one hit use the <src> setWidth </src> function. All
// these restrictions can be overcome when the parameters interface is used
// (see below).
//
// The position angle is the angle between the y axis and the major axis and
// is measured counter-clockwise, so a position angle of 45 degrees rotates
// the major axis to the line where <src>y=-x</src>.
// The position angle is always
// specified and returned in radians. When using the <src> setPA </src>
// function its value must be between -2pi and + 2pi, and the returned value
// from the <src> pa </src> function will always be a value between 0 and
// pi.
//
// The axial ratio can be used as an alternative to specifying the width of
// the minor axis. It is the ratio between the minor and major axis
// widths. The axial ratio is constrained to be between zero and one, and
// specifying something different (using setAxialRatio) will throw an
// exception.
//
// The peak height of the Gaussian can be specified at construction time or
// by using the <src> setHeight </src> function. Alternatively the <src>
// setFlux </src> function can be used to implicitly set the peak height by
// specifying the integrated area under the Gaussian. The height (or flux)
// can be positive, negative or zero, as this class makes no assumptions on
// what quantity the height represents.
//
// <note role=tip> Changing the width of the Gaussian will not affect
// its peak height but will change its flux. So you should always set the
// width before setting the flux. </note>
//
// The parameter interface (see
// <linkto class="FunctionParam">FunctionParam</linkto> class),
// is used to provide an interface to the
// <linkto module="Fitting"> Fitting </linkto> classes.
//
// There are 6 parameters that are used to describe the Gaussian:
// <ol>
// <li> The height of the Gaussian. This is identical to the value
// returned using the <src> height </src> member function.
// <li> The center of the Gaussian in the x direction. This is identical to
// the value returned using the <src> xCenter </src> member function.
// <li> The center of the Gaussian in the y direction. This is identical to
// the value returned using the <src> yCenter </src> member function.
// <li> The width (FWHM) of the Gaussian on one axis. Initially this will be
// the major axis, but if the parameters are adjusted by a Fitting
// class, it may become the axis with the smaller width. To aid
// convergence of the non-linear fitting routines this parameter is
// allowed to be negative. This does not affect the shape of the
// Gaussian as the squares of the widths are used when evaluating the
// function.
// <li> A modified axial ratio. This parameter is the ratio of the width on
// the 'other' axis (which initially is the minor axis) and axis given
// by parameter 4. Because these internal widths are allowed to be
// negative and because there is no constraints on which axis is the
// larger one the modified axial ratio is not constrained to be between
// zero and one.
// <li> The rotation angle. This represents the angle (in radians) between
// the axis used by parameter 4, and the y axis, measured
// counterclockwise. If parameter 4 represents the major axis width
// then this parameter will be identical to the position angle,
// otherwise it will be different by 90 degrees. The tight constraints
// on the value of the rotation angle enforced by the setPA() function
// are relaxed so that any value between -6000 and 6000 is allowed. It
// is still interpreted in radians.
// </ol>
//
// An enumeration for the <src>HEIGHT</src>, <src>XCENTER</src>,
// <src>YCENTER</src>, <src>YWIDTH</src>, <src>RATIO</src>, <src>PANGLE</src>
// parameter index is provided, enabling the setting
// and reading of parameters with the <src>[]</src> operator. The
// <src>mask()</src> methods can be used to check and set the parameter masks.
//
// This class is in general used implicitly by the <src>Gaussian2D</src>
// class only.
//
// <note role=tip>
// Other points to bear in mind when fitting this class to measured data
// are:
// <ul>
// <li> If you need to fit a circular Gaussian to data you MUST set the
// axial ratio to one, and mask the position angle and axial ratio
// parameters. This avoids rank deficiency in the fitting routines as
// the position angle is meaningless when the major and minor axis are
// equal.
// <li> If fitting an elliptical Gaussian your initial model should not be a
// circular Gaussian.
// </ul>
// </note>
//
// </synopsis>
// <example>
// <srcblock>
// Gaussian2D<Double> g(10.0, 0.0, 0.0, 2.0, 1.0, 0.0);
// Vector<Double> x(2);
// x(0) = 1.0; x(1) = 0.5;
// cout << "g(" << x(0) << "," << x(1) << ") = " << g(x) << endl;
// </srcblock>
// </example>
// <motivation>
// Gaussian2D objects allow us to represent models of
// the sky in a more conventional way than the generic interface used in the
// GaussianND class does.
// </motivation>
// <templating arg=T>
// <li> T should have standard numerical operators and exp() function. Current
// implementation only tested for real types (and AutoDiff of them).
// </templating>
// <thrown>
// <li> Assertion in debug mode if attempt is made to set a negative width
// <li> AipsError if incorrect parameter number specified.
// </thrown>
// <todo asof="2001/08/19">
// <li> Gaussians that know about their DFT's could be required eventually.
// </todo>
template<class T> class Gaussian2DParam : public Function<T>
{
public:
//# Enumerations
enum { HEIGHT=0, XCENTER, YCENTER, YWIDTH, RATIO, PANGLE};
//# Constructors
// Constructs the two dimensional Gaussians. Defaults:
// height=1, center=0, width(FWHM)=1, pa=0.
// <group>
Gaussian2DParam();
Gaussian2DParam(const T &height, const Vector<T> ¢er,
const Vector<T> &width, const T &pa);
Gaussian2DParam(const T &height, const T &xCenter, const T &yCenter,
const T &majorAxis, const T &axialRatio,
const T &pa);
// </group>
// Copy constructor (deep copy)
// <group>
Gaussian2DParam(const Gaussian2DParam<T> &other);
template <class W>
Gaussian2DParam(const Gaussian2DParam<W> &other) :
Function<T>(other),
fwhm2int(T(1.0)/sqrt(log(T(16.0)))) { majorAxis(); setPA(PA()); }
// </group>
// Copy assignment (deep copy)
Gaussian2DParam<T> &operator=(const Gaussian2DParam<T> &other);
// Destructor
virtual ~Gaussian2DParam();
//# Operators
// Variable dimensionality
virtual uInt ndim() const { return 2; }
//# Member functions
// Give name of function
virtual const String &name() const { static String x("gaussian2d");
return x; }
// Get or set the peak height of the Gaussian
// <group>
T height() const { return param_p[HEIGHT]; }
void setHeight(const T &height) { param_p[HEIGHT] = height; }
// </group>
// Get or set the analytical integrated area underneath the Gaussian.
// Use these functions as an alternative to the height functions.
// <group>
T flux() const;
void setFlux(const T &flux);
// </group>
// Get or set the center ordinate of the Gaussian
// <group>
Vector<T> center() const;
void setCenter(const Vector<T> ¢er);
T xCenter() const { return param_p[XCENTER]; }
void setXcenter(const T &cnter) { param_p[XCENTER] = cnter; }
T yCenter() const { return param_p[YCENTER]; }
void setYcenter(const T &cnter) { param_p[YCENTER] = cnter; }
// </group>
// Set or get the FWHM of the Gaussian.
// <group>
Vector<T> width() const;
void setWidth(const Vector<T> &width);
T majorAxis() const;
void setMajorAxis(const T &width);
T minorAxis() const;
void setMinorAxis(const T &width);
T axialRatio() const;
void setAxialRatio(const T &axialRatio);
// </group>
// Set/get the rotation angle (orientation) of the Gaussian. PA is given
// in radians counterclockwise.
// <group>
T PA() const;
void setPA(const T &pa);
// </group>
protected:
// Constant to scale halfwidth at 1/e to FWHM
T fwhm2int;
// cached vale of the PA
mutable T thePA;
// cached values of the cos and sine of thePA
// <group>
mutable T theSpa;
mutable T theCpa;
// </group>
// cached vale of the Xwidth = ratio*theYwidth;
mutable T theXwidth;
//# Make members of parent classes known.
protected:
using Function<T>::param_p;
public:
using Function<T>::nparameters;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/Functionals/Gaussian2DParam.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|