Changeset 1140 for trunk/src/STMath.h

Timestamp:

08/16/06 09:12:28 (18 years ago)

Author:

mar637

Message:

add mxExtract the first step to do MX quotients

File:

• trunk/src/STMath.h (modified) (4 diffs)

trunk/src/STMath.h

@@ -62 +62 @@
 
 
-        /**
-          * 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.
-          */
+  /**
+    * 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,
@@ -77 +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.
-          */
+  /**
+    * 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,
@@ -90 +90 @@
                     const std::string& avmode = "SCAN");
 
+  /**
+    * average polarisations together. really only useful if only linears are
+    *  available.
+    * @param in the input Scantable
+    * @param mask an optional mask if weight allows one
+    * @param weight weighting scheme
+    * @return 
+    */
   casa::CountedPtr< Scantable >
     averagePolarisations( const casa::CountedPtr< Scantable > & in,
-                                const std::vector<bool>& mask,
-                                const std::string& weight );
+                          const std::vector<bool>& mask,
+                          const std::string& weight );
 
   casa::CountedPtr<Scantable>
@@ -159 +167 @@
     convertPolarisation( const casa::CountedPtr<Scantable>& in,
                          const std::string& newtype);
+  
+  casa::CountedPtr<Scantable>
+      mxExtract( const casa::CountedPtr<Scantable>& in,
+                 const std::string& scantype = "on" );
 
 private: