casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
KaiserBParam.h
Go to the documentation of this file.
00001 //# KaiserBParam.h: A one dimensional Kaiser-Bessel function
00002 //# Copyright (C) 2002,2005
00003 //# Associated Universities, Inc. Washington DC, USA.
00004 //#
00005 //# This library is free software; you can redistribute it and/or modify it
00006 //# under the terms of the GNU Library General Public License as published by
00007 //# the Free Software Foundation; either version 2 of the License, or (at your
00008 //# option) any later version.
00009 //#
00010 //# This library is distributed in the hope that it will be useful, but WITHOUT
00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00013 //# License for more details.
00014 //#
00015 //# You should have received a copy of the GNU Library General Public License
00016 //# along with this library; if not, write to the Free Software Foundation,
00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00018 //#
00019 //# Correspondence concerning AIPS++ should be addressed as follows:
00020 //#        Internet email: aips2-request@nrao.edu.
00021 //#        Postal address: AIPS++ Project Office
00022 //#                        National Radio Astronomy Observatory
00023 //#                        520 Edgemont Road
00024 //#                        Charlottesville, VA 22903-2475 USA
00025 //#
00026 //# $Id: KaiserBParam.h 21024 2011-03-01 11:46:18Z gervandiepen $
00027 
00028 #ifndef SCIMATH_KAISERBPARAM_H
00029 #define SCIMATH_KAISERBPARAM_H
00030 
00031 //# Includes
00032 #include <casa/aips.h>
00033 #include <scimath/Functionals/Function.h>
00034 #include <casa/BasicSL/String.h>
00035 
00036 namespace casa { //# NAMESPACE CASA - BEGIN
00037 
00038 //# Forward declarations
00039 
00040 // <summary> A one dimensional Kaiser-Bessel function
00041 // </summary>
00042 
00043 // <use visibility=local>
00044 
00045 // <reviewed reviewer="" date="" tests="tFunctionHolder" 
00046 // demos="">
00047 // </reviewed>
00048 
00049 // <prerequisite>
00050 //   <li> <linkto class="FunctionParam">FunctionParam</linkto> class
00051 //   <li> <linkto class="Function">Function</linkto> class
00052 // </prerequisite>
00053 
00054 // <etymology> 
00055 // A Kaiser-Bessel function
00056 // </etymology>
00057 
00058 // <synopsis> 
00059 // A <src>Kaiser-Bessel</src> is described by a height, a center, a width
00060 // (halfwidth) and a parameter.
00061 // The parameters are enumerated by HEIGHT, CENTER, WIDTH, KBPAR. They have
00062 // default values of (1, 0, 1, 2.5).
00063 // </synopsis> 
00064 //
00065 // <example>
00066 // <srcblock>
00067 //    KaiserBFunction<Double> sf;
00068 //    sf(0);            // = 1.0
00069 // </srcblock>
00070 // </example>
00071 
00072 // <templating arg=T>
00073 //  <li> T should have standard numerical operators
00074 // </templating>
00075 
00076 // <thrown>
00077 //    <li> AipsError if incorrect parameter number specified.
00078 // </thrown>
00079 
00080 template<class T> class KaiserBParam : public Function<T>
00081 {
00082 public:
00083   //# Enumerations
00084   // Parameter numbers
00085   enum { HEIGHT=0, CENTER, WIDTH, KBPAR };
00086   
00087   //# Constructors
00088   // Constructs the KaiserB, Defaults:
00089   // height=1, center=0, width=1, kbpar=2.5.
00090   // <note role=warning> Could not use default arguments
00091   // that worked both with gcc and IRIX </note>
00092   // <group>
00093   KaiserBParam();
00094   explicit KaiserBParam(const T &kbpar);
00095   // </group>
00096 
00097   // Copy constructor (deep copy)
00098   KaiserBParam(const KaiserBParam<T> &other);
00099 
00100   // Copy assignment (deep copy)
00101   KaiserBParam<T> &operator=(const KaiserBParam<T> &other);
00102   template <class W>
00103     KaiserBParam(const KaiserBParam<W> &other) :
00104     Function<T>(other) {}
00105     
00106   // Destructor
00107   virtual ~KaiserBParam();
00108 
00109   //# Operators    
00110   virtual uInt ndim() const { return 1; }
00111 
00112   //# Member functions
00113   // Give name of function
00114   virtual const String &name() const { static String x("kaiserbessel");
00115     return x; }
00116 
00117 
00118   //# Make members of parent classes known.
00119 protected:
00120   using Function<T>::param_p;
00121 };
00122 
00123 
00124 } //# NAMESPACE CASA - END
00125 
00126 #ifndef CASACORE_NO_AUTO_TEMPLATES
00127 #include <scimath/Functionals/KaiserBParam.tcc>
00128 #endif //# CASACORE_NO_AUTO_TEMPLATES
00129 #endif