/usr/include/casacore/scimath/Functionals/Lorentzian1D.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 | //# Lorentzian1D.h: A one-dimensional Lorentzian class
//# Copyright (C) 1995,1996,1997,2001,2002,2005
//# 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_LORENTZIAN1D_H
#define SCIMATH_LORENTZIAN1D_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/scimath/Functionals/Lorentzian1DParam.h>
#include <casacore/scimath/Functionals/Function1D.h>
#include <casacore/scimath/Mathematics/AutoDiff.h>
#include <casacore/scimath/Mathematics/AutoDiffMath.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
// <summary> A one dimensional Lorentzian class.</summary>
// <use visibility=export>
// <reviewed reviewer="tcornwel" date="1996/02/22" tests="tLorentzian1D"
// demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="Lorentzian1DParam">Lorentzian1DParam</linkto>
// <li> <linkto class="Function">Function</linkto>
// </prerequisite>
// <etymology>
// A Lorentzian1D functional is designed exclusively for calculating a
// Lorentzian (or Normal) distribution in one dimension.
//# Other classes exist (not yet!)
//# for calculating these functions in two
//# (<linkto class=Lorentzian2D>Lorentzian2D</linkto>) and N
//# (<linkto class=LorentzianND>LorentzianND</linkto>) dimensions.
// </etymology>
// <synopsis>
// A <src>Lorentzian1D</src> is described by a height, center, and width. Its
// fundamental operation is evaluating itself at some <src>x</src>.
// The parameters (height, center and width) may be changed at run time.
//
// The width of the Lorentzian (for the constructors or the <src>setWidth
// </src> function) is always specified in terms of the full width at half
// maximum (FWHM). It is always positive and attempts to set a non-positive
// width will throw an assertion when in debug mode.
//
// The peak height of the Lorentzian 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 Lorentzian. 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 Lorentzian 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="Lorentzian1DParam">Lorentzian1DParam</linkto> class),
// is used to provide an interface to the
// <linkto module="Fitting">Fitting</linkto> classes.
//
// There are 3 parameters that are used to describe the Lorentzian:
// <ol>
// <li> The height of the Lorentzian. This is identical to the value
// returned using the <src>height()</src> member function.
// <li> The center of the Lorentzian in the x direction. This is identical to
// the value returned using the <src>center()</src> member function.
// <li> The width (FWHM) of the Lorentzian. To aid convergence of
// the non-linear fitting routines this parameter is allowed to be
// negative. This does not affect the shape of the Lorentzian as the
// square of the width is used when evaluating the function.
// </ol>
//
// An enumeration for the <src>HEIGHT</src>, <src>WIDTH</src> and
// <src>CENTER</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.
//
// </synopsis>
// <example>
// <srcblock>
// Lorentzian<Double> gf(5.0, 25.0, 7);
// gf(25); // = 5.0
// gf[HEIGHT](1.0);
// gf.setWidth(2.0);
// gf[CENTER](0.0);
// gf(1); // = 0.5*height = 0.5
// </srcblock>
// </example>
// <templating arg=T>
// <li> T should have standard numerical operators and exp() function. Current
// implementation only tested for real types.
// <li> To obtain derivatives, the derivatives should be defined.
// </templating>
// <thrown>
// <li> Assertion in debug mode if attempt is made to set a negative width
// <li> AipsError if incorrect parameter number specified.
// <li> Assertion in debug mode if operator(Vector<>) with empty Vector
// </thrown>
// <todo asof="2001/08/19">
// <li> Lorentzians that know about their DFT's could be required eventually.
// </todo>
template<class T> class Lorentzian1D : public Lorentzian1DParam<T> {
public:
//# Enumerations
//# Constructors
// Constructs the one dimensional Lorentzians. Defaults:
// height=1, center=0, width(FWHM)=1.
// <note role=warning> Could not use default arguments
// that worked both with gcc and IRIX </note>
// <group>
Lorentzian1D() : Lorentzian1DParam<T>() {};
explicit Lorentzian1D(const T &height) : Lorentzian1DParam<T>(height) {};
Lorentzian1D(const T &height, const T ¢er) :
Lorentzian1DParam<T>(height, center) {};
Lorentzian1D(const T &height, const T ¢er, const T &width) :
Lorentzian1DParam<T>(height, center, width) {};
// </group>
// Copy constructor (deep copy)
// <group>
Lorentzian1D(const Lorentzian1D<T> &other) : Lorentzian1DParam<T>(other) {};
template <class W>
Lorentzian1D(const Lorentzian1D<W> &other) : Lorentzian1DParam<T>(other) {}
// </group>
// Copy assignment (deep copy)
Lorentzian1D<T> &operator=(const Lorentzian1D<T> &other) {
Lorentzian1DParam<T>::operator=(other); return *this; };
// Destructor
virtual ~Lorentzian1D() {};
//# Operators
// Evaluate the Lorentzian at <src>x</src>.
// <group>
virtual T eval(typename Function1D<T>::FunctionArg x) const;
// </group>
//# Member functions
// Return a copy of this object from the heap. The caller is responsible
// for deleting this pointer.
// <group>
virtual Function<T> *clone() const { return new Lorentzian1D<T>(*this); };
virtual Function<typename FunctionTraits<T>::DiffType> *cloneAD() const {
return new Lorentzian1D<typename FunctionTraits<T>::DiffType>(*this); };
virtual Function<typename FunctionTraits<T>::BaseType> *cloneNonAD() const {
return new Lorentzian1D<typename FunctionTraits<T>::BaseType>(*this); };
// </group>
//# Make members of parent classes known.
protected:
using Lorentzian1DParam<T>::param_p;
public:
using Lorentzian1DParam<T>::HEIGHT;
using Lorentzian1DParam<T>::CENTER;
using Lorentzian1DParam<T>::WIDTH;
using Lorentzian1DParam<T>::fwhm2int;
};
#define Lorentzian1D_PS Lorentzian1D
// <summary> Partial specialization of Lorentzian1D for <src>AutoDiff</src>
// </summary>
// <synopsis>
// <note role=warning> The name <src>Lorentzian1D_PS</src> is only for cxx2html
// documentation problems. Use <src>Lorentzian1D</src> in your code.</note>
// </synopsis>
template <class T> class Lorentzian1D_PS<AutoDiff<T> > :
public Lorentzian1DParam<AutoDiff<T> >
{
public:
//# Constructors
// Constructs one dimensional Lorentzians.
// <group>
Lorentzian1D_PS() : Lorentzian1DParam<AutoDiff<T> >() {};
explicit Lorentzian1D_PS(const AutoDiff<T> &height) :
Lorentzian1DParam<AutoDiff<T> >(height) {};
Lorentzian1D_PS(const AutoDiff<T> &height, const AutoDiff<T> ¢er) :
Lorentzian1DParam<AutoDiff<T> >(height, center) {};
Lorentzian1D_PS(const AutoDiff<T> &height, const AutoDiff<T> ¢er,
const AutoDiff<T> &width) :
Lorentzian1DParam<AutoDiff<T> >(height, center, width) {};
// </group>
// Copy constructor (deep copy)
// <group>
Lorentzian1D_PS(const Lorentzian1D_PS &other) :
Lorentzian1DParam<AutoDiff<T> >(other) {};
template <class W>
Lorentzian1D_PS(const Lorentzian1D_PS<W> &other) :
Lorentzian1DParam<AutoDiff<T> >(other) {}
// </group>
// Copy assignment (deep copy)
Lorentzian1D_PS<AutoDiff<T> > &
operator=(const Lorentzian1D_PS<AutoDiff<T> > &other) {
Lorentzian1DParam<AutoDiff<T> >::operator=(other); return *this; };
// Destructor
virtual ~Lorentzian1D_PS() {};
//# Operators
// Evaluate the Lorentzian and its derivatives at <src>x</src>.
// <group>
virtual AutoDiff<T> eval(typename Function<AutoDiff<T> >::FunctionArg x) const;
// </group>
//# Member functions
// Return a copy of this object from the heap. The caller is responsible
// for deleting this pointer.
// <group>
virtual Function<AutoDiff<T> > *clone() const {
return new Lorentzian1D<AutoDiff<T> >(*this); };
virtual Function<typename FunctionTraits<AutoDiff<T> >::DiffType>
*cloneAD() const {
return new Lorentzian1D<typename FunctionTraits<AutoDiff<T> >::DiffType>
(*this); };
virtual Function<typename FunctionTraits<AutoDiff<T> >::BaseType>
*cloneNonAD() const {
return new Lorentzian1D<typename FunctionTraits<AutoDiff<T> >::BaseType>
(*this); };
// </group>
//# Make members of parent classes known.
protected:
using Lorentzian1DParam<AutoDiff<T> >::param_p;
public:
using Lorentzian1DParam<AutoDiff<T> >::HEIGHT;
using Lorentzian1DParam<AutoDiff<T> >::CENTER;
using Lorentzian1DParam<AutoDiff<T> >::WIDTH;
using Lorentzian1DParam<AutoDiff<T> >::fwhm2int;
};
#undef Lorentzian1D_PS
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include "Lorentzian1D.tcc"
#include "Lorentzian1D2.tcc"
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|