Changeset 1106

Timestamp:

08/03/06 10:28:39 (18 years ago)

Author:

mar637

Message:

added doxygen documentation

Location:

trunk/src

Files:

• Logger.h (modified) (1 diff)
• STAsciiWriter.h (modified) (1 diff)
• STMath.h (modified) (4 diffs)

trunk/src/Logger.h

@@ +1 @@
+//
+// C++ Interface: Logger
+//
+// Description:
+//
+//
+// Author: Malte Marquarding <asap@atnf.csiro.au>, (C) 2005
+//
+// Copyright: See COPYING file that comes with this distribution
+//
+//
 #ifndef ASAPLOGGER_H
 #define ASAPLOGGER_H

trunk/src/STAsciiWriter.h

@@ -45 +45 @@
 
 namespace asap {
-
+/**
+ * A class to export a Scnatble to ASCII file(s)
+ */
 class STAsciiWriter : public Logger {
 public:

trunk/src/STMath.h

@@ -30 +30 @@
 
 /**
-Mathmatical operations on Scantable objects
-
-@author Malte Marquarding
+        * Mathmatical operations on Scantable objects
+        * @author Malte Marquarding
 */
 class STMath : private Logger {
 public:
-
+        // typedef for long method name
   typedef casa::InterpolateArray1D<casa::Double,
                                    casa::Float>::InterpolationMethod imethod;
 
+  // typedef for std::map
   typedef std::map<std::string, imethod> imap;
 
+/**
+  * whether to operate on the given Scantable or return a new one
+  * @param insitu the toggle for this behaviour
+  */
   STMath(bool insitu=true);
 
@@ -47 +51 @@
 
   /**
-   * set the @attr insitu attribute
-   * @param b
+   * get the currnt @attr inistu state
    */
   bool insitu() const { return insitu_;};
+  
+  /**
+   * set the currnt @attr inistu state
+   * @param b the new state
+   */
   void setInsitu(bool b) { insitu_ = b; };
 
+
+        /**
+          * average a vector of Scantables
+          * @param in the vector of Scantables to average
+          * @param an optional mask to apply on specific weights
+          * @param weight weighting scheme
+          * @param avmode the mode ov averaging. Per "SCAN" or "ALL".
+          * @return a casa::CountedPtr<Scantable> which either holds a new Scantable
+          * or returns the imput pointer.
+          */
   casa::CountedPtr<Scantable>
     average( const std::vector<casa::CountedPtr<Scantable> >& in,
@@ -59 +77 @@
              const std::string& avmode = "SCAN");
 
+        /**
+          * median average a vector of Scantables. See also STMath::average
+          * @param in the Scantable to average
+          * @param mode the averaging mode. Currently only "MEDIAN"
+          * @param avmode the mode ov averaging. Per "SCAN" or "ALL".
+          * @return a casa::CountedPtr<Scantable> which either holds a new Scantable
+          * or returns the imput pointer.
+          */
   casa::CountedPtr<Scantable>
     averageChannel( const casa::CountedPtr<Scantable> & in,
@@ -122 +148 @@
     rotateLinPolPhase( const casa::CountedPtr<Scantable>& in, float phase);
 
-  /// @todo frequency alignment
-
   casa::CountedPtr<Scantable>
     swapPolarisations(const casa::CountedPtr<Scantable>& in);