casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
SincParam.h
Go to the documentation of this file.
00001 //# SincParam.h: A one dimensional sin(x)/x
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: SincParam.h 21024 2011-03-01 11:46:18Z gervandiepen $
00027 
00028 #ifndef SCIMATH_SINCPARAM_H
00029 #define SCIMATH_SINCPARAM_H
00030 
00031 //# Includes
00032 #include <casa/aips.h>
00033 #include <casa/BasicSL/String.h>
00034 #include <scimath/Functionals/Function.h>
00035 
00036 namespace casa { //# NAMESPACE CASA - BEGIN
00037 
00038 //# Forward declarations
00039 
00040 // <summary> A one dimensional sin(x)/x
00041 // </summary>
00042 
00043 // <use visibility=local>
00044 
00045 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" 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 1-dimensional sinc function.
00056 // </etymology>
00057 
00058 // <synopsis> 
00059 // A <src>Sinc</src> is described by a height, a center and a width
00060 // (halfwidth). The value is:
00061 // <srcblock>
00062 //      let y = (x-center)/width
00063 //      height                              (x == center)
00064 //      height*sin(pi*y)/(pi*y)             (x |= center)
00065 // </srcblock>
00066 // The parameters are enumerated by HEIGHT, CENTER and WIDTH. They have
00067 // default values of (1, 0, 1).
00068 // </synopsis> 
00069 //
00070 // <example>
00071 // <srcblock>
00072 //    SincFunction<Double> sf(5.0, 25.0, 7);
00073 //    sf(25);            // = 5.0
00074 // </srcblock>
00075 // </example>
00076 
00077 // <templating arg=T>
00078 //  <li> T should have standard numerical operators
00079 // </templating>
00080 
00081 // <thrown>
00082 //    <li> AipsError if incorrect parameter number specified.
00083 // </thrown>
00084 
00085 template<class T> class SincParam : public Function<T>
00086 {
00087 public:
00088   //# Enumerations
00089   // Parameter numbers
00090   enum { HEIGHT=0, CENTER, WIDTH };
00091   
00092   //# Constructors
00093   // Constructs the Sinc, Defaults:
00094   // height=1, center=0, width=1.
00095   // <note role=warning> Could not use default arguments
00096   // that worked both with gcc and IRIX </note>
00097   // <group>
00098   SincParam();
00099   explicit SincParam(const T &height);
00100   SincParam(const T &height, const T &center);
00101   SincParam(const T &height, const T &center, const T &width);
00102   // </group>
00103 
00104   // Copy constructor (deep copy)
00105   // <group>
00106   SincParam(const SincParam<T> &other);
00107   template <class W>
00108     SincParam(const SincParam<W> &other) :
00109     Function<T>(other) {}
00110   // </group>
00111 
00112   // Copy assignment (deep copy)
00113   SincParam<T> &operator=(const SincParam<T> &other);
00114     
00115   // Destructor
00116   virtual ~SincParam();
00117 
00118   //# Operators    
00119   virtual uInt ndim() const { return 1; }
00120 
00121   //# Member functions
00122   // Give name of function
00123   virtual const String &name() const { static String x("sinc");
00124     return x; }
00125 
00126 
00127   //# Make members of parent classes known.
00128 protected:
00129   using Function<T>::param_p;
00130 public:
00131   using Function<T>::nparameters;
00132 };
00133 
00134 
00135 } //# NAMESPACE CASA - END
00136 
00137 #ifndef CASACORE_NO_AUTO_TEMPLATES
00138 #include <scimath/Functionals/SincParam.tcc>
00139 #endif //# CASACORE_NO_AUTO_TEMPLATES
00140 #endif