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
|
//# KaiserBFunction.h: A one dimensional Kaiser-Bessel function
//# Copyright (C) 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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef SCIMATH_KAISERBFUNCTION_H
#define SCIMATH_KAISERBFUNCTION_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/scimath/Functionals/KaiserBParam.h>
#include <casacore/scimath/Functionals/Function.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
// <summary> A one dimensional Kaiser-Bessel function
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="tFunctionHolder"
// demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="KaiserBParam">KaiserBParam</linkto>
// <li> <linkto class="Function">Function</linkto>
// </prerequisite>
// <etymology>
// A Kaiser-Bessel function
// </etymology>
// <synopsis>
// A <src>Kaiser-Bessel</src> is described by a height, a center, a width
// (halfwidth) and a parameter.
// The parameters are enumerated by HEIGHT, CENTER, WIDTH, KBPAR. They have
// default values of (1, 0, 1, 2.5).
// </synopsis>
//
// <example>
// <srcblock>
// KaiserBFunction<Double> sf;
// sf(0); // = 1.0
// </srcblock>
// </example>
// <templating arg=T>
// <li> T should have standard numerical operators
// </templating>
// <thrown>
// <li> AipsError if incorrect parameter number specified.
// </thrown>
//
template<class T> class KaiserBFunction : public KaiserBParam<T>
{
public:
//# Constructors
// Constructs the KaiserBFunction, Defaults:
// height=1, center=0, width=1, kbpar=2.5.
// <note role=warning> Could not use default arguments
// that worked both with gcc and IRIX </note>
// <group>
KaiserBFunction() : KaiserBParam<T>() {}
explicit KaiserBFunction(const T &kbpar) :
KaiserBParam<T>(kbpar) {}
// </group>
// Copy constructor (deep copy)
// <group>
KaiserBFunction(const KaiserBFunction<T> &other) : KaiserBParam<T>(other) {}
template <class W>
KaiserBFunction(const KaiserBFunction<W> &other) : KaiserBParam<T>(other) {}
// </group>
// Copy assignment (deep copy)
KaiserBFunction<T> &operator=(const KaiserBFunction<T> &other) {
KaiserBParam<T>::operator=(other); return *this; }
// Destructor
virtual ~KaiserBFunction() {}
//# Operators
// Evaluate the KaiserB at <src>x</src>.
// If a vector is used as the argument only its first element is used.
// <group>
virtual T eval(typename Function<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 KaiserBFunction<T>(*this); }
virtual Function<typename FunctionTraits<T>::DiffType> *cloneAD() const {
return new KaiserBFunction<typename FunctionTraits<T>::DiffType>(*this); }
virtual Function<typename FunctionTraits<T>::BaseType> *cloneNonAD() const {
return new KaiserBFunction<typename FunctionTraits<T>::BaseType>(*this); }
// </group>
//# Make members of parent classes known.
protected:
using KaiserBParam<T>::param_p;
public:
using KaiserBParam<T>::KBPAR;
using KaiserBParam<T>::CENTER;
using KaiserBParam<T>::WIDTH;
using KaiserBParam<T>::HEIGHT;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/Functionals/KaiserBFunction.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|
