Changeset 1104 for trunk/src

Timestamp:

08/02/06 14:58:50 (18 years ago)

Author:

mar637

Message:

added doxygen documentation

Location:

trunk/src

Files:

• Logger.h (modified) (1 diff)
• RowAccumulator.h (modified) (3 diffs)
• Scantable.h (modified) (5 diffs)

trunk/src/Logger.h

@@ -33 +33 @@
   /**
    * push another message into the logger
-   * @param[in] the message
-   * @param[in] whether to add a newline character at the end
+   * @param[in] s the message
+   * @param[in] newline whether to add a newline character at the end
    */  
   void pushLog(const std::string& s, bool newline=true) const;
   /**
    * pop the message form the logger
-   * @returns the log message string
+   * @return the log message string
    */  
   std::string popLog() const;

trunk/src/RowAccumulator.h

@@ -17 +17 @@
 
 namespace asap {
-
+/**
+  * This class accumulates spectra and weights and returns the averaged data
+  * @brief Class for averaging of spectra
+  * @author Malte Marquarding
+  * @date $Date:$
+  * @version
+  */
 class RowAccumulator {
-
 
 public:
 
+  /**
+   * Constructor taking a weight type as defined in @ref STDefs
+   */
   RowAccumulator(WeightType wt = asap::NONE);
 
  ~RowAccumulator();
 
+        /**
+         * add a new "row" to the accumulator
+         * @param v the spectrum
+         * @param m the mask for the spectrum
+         * @param tsys the Tsys corresponing to the spectrum
+         * @param interval the intergration time
+         * @param the time of the observation
+         */
   void add(const casa::Vector<casa::Float>& v,
            const casa::Vector<casa::Bool>& m,
@@ -32 +48 @@
            casa::Double interval,
            casa::Double time);
-
+        /**
+         * Also set a user mask which get combined with the individual masks
+         * from the spectra
+         * @param m a boolean mask of teh same length as the spectrum
+         */
   void setUserMask(const casa::Vector<casa::Bool>& m);
-
+        /**
+         * Get the spectrum. Applies the normalisation (averaging)
+         * @return the spectrum vector
+         */
   casa::Vector<casa::Float> getSpectrum() const;
+        /**
+         * Get the Tsys. Applies the normalisation (averaging)
+         * @return the Tsys vector
+         */
   casa::Vector<casa::Float> getTsys() const;
+        /**
+         * Get the spectrum's mask. Applies the normalisation (averaging)
+         * @return the mask vector
+         */
   casa::Vector<casa::Bool> getMask() const;
-
+        /**
+         * Get the total interval.
+         * @return the integration time
+         */
   casa::Double getInterval() const;
+        /**
+         * Get the time of the observation. Retrieves the "mean" time.
+         * @return the integration time
+         */  
   casa::Double getTime() const;
-
+        /**
+         * Reset the acummulator to the state at construction.
+         */
   void reset();
 
@@ -55 +95 @@
   WeightType weightType_;
   casa::Bool initialized_;
-  //these are a Vector
+  //these are Vectors
   casa::MaskedArray<casa::Float> spectrum_;
   casa::MaskedArray<casa::Float> n_, weightSum_;

trunk/src/Scantable.h

@@ -90 +90 @@
   /**
    * get a const reference to the underlying casa::Table
-   * @return consantcasa::Table reference
+   * @return const \ref casa::Table reference
    */
   const casa::Table& table() const;
@@ -146 +146 @@
 
   /**
-   * return the number of scans in the table
+   * The number of scans in the table
    * @return number of scans in the table
    */
@@ -159 +159 @@
   casa::MPosition getAntennaPosition() const;
 
+        /**
+         * the @ref casa::MDirection for a specific row
+         * @param[in] whichrow the row number 
+         * return casa::MDirection
+         */
   casa::MDirection getDirection( int whichrow ) const;
 
+        /**
+         * get the direction type as a string, e.g. "J2000"
+         * @param[in] whichrow the row number
+         * return the direction string
+         */
   std::string getDirectionString( int whichrow ) const;
 
+        /**
+         * set the direction type as a string, e.g. "J2000"
+         * @param[in] the direction type
+         */     
   void setDirectionRefString(const std::string& refstr="");
-
-  std::string getDirectionRefString() const;
+  /**
+   * get the direction reference string
+   * @return a string describing the direction reference
+   */
+  std::string getDirectionRefString() const;    /**
+         * get the direction type as a string, e.g. "J2000"
+         * param[in] whichrow the row number
+         * return the direction string
+         */
+  
 
   /**
@@ -192 +214 @@
   /**
    * "hard" flag the data, this flags everything selected in setSelection()
+   * param[in] msk a boolean mask of length nchan describing the points to
+   * to be flagged
    */
   void flag( const std::vector<bool>& msk = std::vector<bool>());
@@ -239 +263 @@
    * @param scanno the scan number to get the number of rows for.
    * If scanno<0 the number is retrieved from the header.
-   * @return
+   * @return the number of rows (for the specified scanno)
    */
   int nrow(int scanno=-1) const;