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

trunk/SophyaLib/SkyT/trianglefilt.cc

@@ -1 +1 @@
 //--------------------------------------------------------------------------
 // File and Version Information:
-//      $Id: trianglefilt.cc,v 1.4 1999-11-29 16:59:13 ansari Exp $
+//      $Id: trianglefilt.cc,v 1.5 2000-04-13 14:10:46 ansari Exp $
 //
 // Description:
@@ -21 +21 @@
 // Constructor --
 //----------------
-
+/*! 
+ * \class SOPHYA::TriangleFilter
+ * triangle detector response
+ */
 TriangleFilter::TriangleFilter()
    : SpectralResponse()
 {
 }
+/*! Constructor: nupeak is the frequency value at the hat of the triangle and
+  valueatpeak is the corresponding transmission value. */
 TriangleFilter::TriangleFilter(double numin, double numax,double nupeak, double valueatpeak)
    : SpectralResponse(numin, numax)
@@ -44 +49 @@
 //              ---------------------------
 
+/*! The transmission function is a triangle defined in the constructor
+by numin and numax (for which the transmission goes to 0.) and
+the hat of the triangle (defined by a peak frequency and the corresponding
+transmission value. */
 double 
 TriangleFilter::transmission(double nu) const
@@ -64 +73 @@
 TriangleFilter::peakTransmission() const 
 {
-return _peakTransmission;
+  return _peakTransmission;
 }