Changeset 135 for trunk

Timestamp:

12/20/04 15:53:55 (20 years ago)

Author:

kil064

Message:

add function 'stats'
function 'rms' -> 'stddev'

File:

• trunk/python/scantable.py (modified) (7 diffs)

trunk/python/scantable.py

@@ -50 +50 @@
             self._vb = args[0]
             return
-
 
     def copy(self):
@@ -109 +108 @@
         Example:
             scan.set_selection(0,0,1)
-            pol1rms = scan.rms(all=False) # returns rms for beam=0
+            pol1sig = scan.stats(all=False) # returns std dev for beam=0
                                          # if=0, pol=1
         """
@@ -135 +134 @@
         return i,j,k
 
-    def rms(self,mask=None, all=True):
-        """
-        Determine the root mean square of the current beam/if/pol
+    def stats(self, stat='stddev', mask=None, all=True):
+        """
+        Determine the specified statistic of the current beam/if/pol
         Takes a 'mask' as an optional parameter to specify which
         channels should be excluded.
         Parameters:
-            mask:    an optional mask specifying where the rms
+            stat:    'min', 'max', 'sumsq', 'sum', 'mean'
+                     'var', 'stddev', 'avdev', 'rms', 'median'
+            mask:    an optional mask specifying where the statistic
                      should be determined.
             all:     optional flag to show all or a selected
@@ -149 +150 @@
             scan.set_unit('channel')
             msk = scan.create_mask([100,200],[500,600])
-            scan.rms(mask=m)
-        """
-        from asap._asap import rms as _rms
+            scan.stats(stat='mean', mask=m)
+        """
+        from asap._asap import stats as _stats
         if mask == None:
             mask = ones(self.nchan())
@@ -163 +164 @@
                     for k in range(self.npol()):
                         self.setpol(k)
-                        rmsval = _rms(self,mask)
-                        tmp.append(rmsval)
-                        out += 'Beam[%d], IF[%d], Pol[%d] = %3.3f\n' % (i,j,k,rmsval)
-            if self._vb:
-                print out
+                        statVal = _stats(self,mask,stat)
+                        tmp.append(statVal)
+#                        out += 'Beam[%d], IF[%d], Pol[%d] = %3.3f\n' % (i,j,k,statVal)
+#            if self._vb:
+#                print out
             return tmp
 
@@ -174 +175 @@
             j = self.getif()
             k = self.getpol()
-            rmsval = _rms(self,mask)
-            out = 'Beam[%d], IF[%d], Pol[%d] = %3.3f' % (i,j,k,rmsval)
-            if self._vb:
-                print out
-            return rmsval
+            statVal = _stats(self,mask,stat)
+#            out = 'Beam[%d], IF[%d], Pol[%d] = %3.3f' % (i,j,k,statVal)
+#            if self._vb:
+#                print out
+            return statVal
+
+    def stddev(self,mask=None, all=True):
+        """
+        Determine the standard deviation of the current beam/if/pol
+        Takes a 'mask' as an optional parameter to specify which
+        channels should be excluded.
+        Parameters:
+            mask:    an optional mask specifying where the standard
+                     deviation should be determined.
+            all:     optional flag to show all or a selected
+                     spectrum of Beam/IF/Pol
+
+        Example:
+            scan.set_unit('channel')
+            msk = scan.create_mask([100,200],[500,600])
+            scan.stddev(mask=m)
+        """
+        return self.stats(stat='stddev',mask=mask, all=all);
 
     def get_tsys(self, all=True):
@@ -373 +392 @@
         Parameters:
             what:     a choice of 'spectrum' (default) or 'tsys'
-            col:      which out of Beams, IFs, Pols (default)
-                      should be colour stacked
+            col:      which out of Beams/IFs/Pols should be colour stacked
             panel:    set up multiple panels, currently not working.
         """