Changeset 909 in Sophya for trunk/SophyaLib/SkyT/gaussfilt.cc

Timestamp:

Apr 13, 2000, 4:10:46 PM (25 years ago)

Author:

ansari

Message:

Sophie: adding documentation for Doxygen in the .cc files:wq

File:

• trunk/SophyaLib/SkyT/gaussfilt.cc (modified) (4 diffs)

trunk/SophyaLib/SkyT/gaussfilt.cc

@@ -1 +1 @@
 //--------------------------------------------------------------------------
 // File and Version Information:
-//      $Id: gaussfilt.cc,v 1.4 1999-11-29 14:16:04 ansari Exp $
+//      $Id: gaussfilt.cc,v 1.5 2000-04-13 14:10:44 ansari Exp $
 //
 // Description:
@@ -19 +19 @@
 #include "gaussfilt.h"
 
-//----------------
-// Constructor --
-//----------------
+/*! 
+ * \class SOPHYA::GaussianFilter
+ * Gaussian detector response
+ */
 GaussianFilter::GaussianFilter()
   : SpectralResponse()
@@ -28 +29 @@
 }
 
+/*! Constructor: the parameters correspond to the function defined in the 
+  <a href="#gausseq"> equation </a> below 
+*/
 GaussianFilter::GaussianFilter(double nu0, double s, double a, double numin, double numax)
   : SpectralResponse(numin, numax)
@@ -46 +50 @@
 //              ---------------------------
 
+/*! The transmission function is the wel known gaussian:
+  <a name="gausseq"> </a>
+  \f[
+  \hbox{transmission}= A  e^{-{({\nu-\nu_0\over s})^2}};
+  \f]
+*/
 
 double