Changeset 909 in Sophya for trunk/SophyaLib/SkyT/specresp.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/specresp.cc (modified) (6 diffs)

trunk/SophyaLib/SkyT/specresp.cc

@@ -1 +1 @@
 //--------------------------------------------------------------------------
 // File and Version Information:
-//      $Id: specresp.cc,v 1.3 1999-11-29 14:16:08 ansari Exp $
+//      $Id: specresp.cc,v 1.4 2000-04-13 14:10:45 ansari Exp $
 //
 // Description:
@@ -21 +21 @@
 #include "tvector.h"
 
+/*! 
+ * \class SOPHYA::SpectralResponse <BR>
+ SpectralResponse corresponds to a detector filter's
+ response as a function of the frequency.
+ The SpectralResponse class is an abstract class.
+ The virtual constructor takes as arguments the
+ minimum and maximum values of the frequency range on
+ which the detector response is defined
+ */
 //----------------
 // Constructor --
@@ -107 +116 @@
 
 
+/*! 
+  This function performs the integration
+  of the transmission function in its frequency range 
+  (defined when instanciating an object of on of the
+  subclasses)
+*/
 double 
 SpectralResponse::IntegratedSpect()  const
@@ -114 +129 @@
 }
 
+/*! 
+  The IntegratedSpect function performs the integration
+  of the transmission function in a frequency range <BR> defined by
+  numin and numax.
+*/
 double 
 SpectralResponse::IntegratedSpect(double numin, double numax) const 
@@ -137 +157 @@
 }
 
+/*! 
+  The logIntegratedSpect function performs the integration
+  of the logarithm of the transmission function in a frequency range <BR> defined by
+  numin and numax.
+*/
 double 
 SpectralResponse::logIntegratedSpect(double numin, double numax) const 
@@ -154 +179 @@
 }
 
+/*! 
+  Same than IntegratedSpect(numin,numax) over its
+  frequency range defined at the initialisation
+*/
 double 
 SpectralResponse::logIntegratedSpect()  const