casacore
Loading...
Searching...
No Matches
KaiserBParam.h
Go to the documentation of this file.
1//# KaiserBParam.h: A one dimensional Kaiser-Bessel function
2//# Copyright (C) 2002,2005
3//# Associated Universities, Inc. Washington DC, USA.
4//#
5//# This library is free software; you can redistribute it and/or modify it
6//# under the terms of the GNU Library General Public License as published by
7//# the Free Software Foundation; either version 2 of the License, or (at your
8//# option) any later version.
9//#
10//# This library is distributed in the hope that it will be useful, but WITHOUT
11//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13//# License for more details.
14//#
15//# You should have received a copy of the GNU Library General Public License
16//# along with this library; if not, write to the Free Software Foundation,
17//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18//#
19//# Correspondence concerning AIPS++ should be addressed as follows:
20//# Internet email: aips2-request@nrao.edu.
21//# Postal address: AIPS++ Project Office
22//# National Radio Astronomy Observatory
23//# 520 Edgemont Road
24//# Charlottesville, VA 22903-2475 USA
25//#
26//# $Id$
27
28#ifndef SCIMATH_KAISERBPARAM_H
29#define SCIMATH_KAISERBPARAM_H
30
31//# Includes
32#include <casacore/casa/aips.h>
33#include <casacore/scimath/Functionals/Function.h>
34#include <casacore/casa/BasicSL/String.h>
35
36namespace casacore { //# NAMESPACE CASACORE - BEGIN
37
38//# Forward declarations
39
40// <summary> A one dimensional Kaiser-Bessel function
41// </summary>
42
43// <use visibility=local>
44
45// <reviewed reviewer="" date="" tests="tFunctionHolder"
46// demos="">
47// </reviewed>
48
49// <prerequisite>
50// <li> <linkto class="FunctionParam">FunctionParam</linkto> class
51// <li> <linkto class="Function">Function</linkto> class
52// </prerequisite>
53
54// <etymology>
55// A Kaiser-Bessel function
56// </etymology>
57
58// <synopsis>
59// A <src>Kaiser-Bessel</src> is described by a height, a center, a width
60// (halfwidth) and a parameter.
61// The parameters are enumerated by HEIGHT, CENTER, WIDTH, KBPAR. They have
62// default values of (1, 0, 1, 2.5).
63// </synopsis>
64//
65// <example>
66// <srcblock>
67// KaiserBFunction<Double> sf;
68// sf(0); // = 1.0
69// </srcblock>
70// </example>
71
72// <templating arg=T>
73// <li> T should have standard numerical operators
74// </templating>
75
76// <thrown>
77// <li> AipsError if incorrect parameter number specified.
78// </thrown>
79
80template<class T> class KaiserBParam : public Function<T>
81{
82public:
83 //# Enumerations
84 // Parameter numbers
85 enum { HEIGHT=0, CENTER, WIDTH, KBPAR };
86
87 //# Constructors
88 // Constructs the KaiserB, Defaults:
89 // height=1, center=0, width=1, kbpar=2.5.
90 // <note role=warning> Could not use default arguments
91 // that worked both with gcc and IRIX </note>
92 // <group>
94 explicit KaiserBParam(const T &kbpar);
95 // </group>
96
97 // Copy constructor (deep copy)
99
100 // Copy assignment (deep copy)
102 template <class W>
104 Function<T>(other) {}
105
106 // Destructor
107 virtual ~KaiserBParam();
108
109 //# Operators
110 virtual uInt ndim() const { return 1; }
111
112 //# Member functions
113 // Give name of function
114 virtual const String &name() const { static String x("kaiserbessel");
115 return x; }
116
117
118 //# Make members of parent classes known.
119protected:
120 using Function<T>::param_p;
121};
122
123
124} //# NAMESPACE CASACORE - END
125
126#ifndef CASACORE_NO_AUTO_TEMPLATES
127#include <casacore/scimath/Functionals/KaiserBParam.tcc>
128#endif //# CASACORE_NO_AUTO_TEMPLATES
129#endif
FunctionParam< T > param_p
The parameters and masks.
Definition Function.h:332
virtual const String & name() const
Give name of function.
KaiserBParam< T > & operator=(const KaiserBParam< T > &other)
Copy assignment (deep copy)
KaiserBParam()
Constructs the KaiserB, Defaults: height=1, center=0, width=1, kbpar=2.5.
KaiserBParam(const KaiserBParam< W > &other)
virtual ~KaiserBParam()
Destructor.
virtual uInt ndim() const
Returns the number of dimensions of function.
KaiserBParam(const KaiserBParam< T > &other)
Copy constructor (deep copy)
KaiserBParam(const T &kbpar)
String: the storage and methods of handling collections of characters.
Definition String.h:225
this file contains all the compiler specific defines
Definition mainpage.dox:28
unsigned int uInt
Definition aipstype.h:51