Changeset 436 for trunk/python

Timestamp:

02/14/05 19:44:43 (20 years ago)

Author:

kil064

Message:

arg. 'all' -> 'allaxes' to be consistent with asapmath.py
use same doc. fragment from asapmath.py as well

File:

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

trunk/python/scantable.py

@@ -213 +213 @@
         return i,j,k
 
-    def stats(self, stat='stddev', mask=None, all=None):
+    def stats(self, stat='stddev', mask=None, allaxes=None):
         """
         Determine the specified statistic of the current beam/if/pol
@@ -223 +223 @@
             mask:    an optional mask specifying where the statistic
                      should be determined.
-            all:     if true show all (default or .asaprc) rather
-                     that the cursor selected spectrum of Beam/IF/Pol
-
+            allaxes: if True apply to all spectra. Otherwise
+                     apply only to the selected (beam/pol/if)spectra only.
+                     The default is taken from .asaprc (True if none)
         Example:
             scan.set_unit('channel')
@@ -231 +231 @@
             scan.stats(stat='mean', mask=m)
         """
-        if all is None: all = rcParams['scantable.allaxes']
+        if allaxes is None: allaxes = rcParams['scantable.allaxes']
         from asap._asap import stats as _stats
         from numarray import array,zeros,Float
@@ -238 +238 @@
         axes = ['Beam','IF','Pol','Time']
 
-        if all:
+        beamSel,IFSel,polSel = (self.getbeam(),self.getif(),self.getpol())
+        if allaxes:
             n = self.nbeam()*self.nif()*self.npol()*self.nrow()
             shp = [self.nbeam(),self.nif(),self.npol(),self.nrow()]
@@ -254 +255 @@
             if self._vb:
                 self._print_values(retval,stat,tm)
+            self.setbeam(beamSel)
+            self.setif(IFSel)
+            self.setpol(polSel)
             return retval
 
         else:
-            i,j,k = (self.getbeam(),self.getif(),self.getpol())
             statval = _stats(self,mask,stat,-1)
             out = ''
@@ -263 +266 @@
                 tm = self._gettime(l)
                 out += 'Time[%s]:\n' % (tm)
-                if self.nbeam() > 1: out +=  ' Beam[%d] ' % (i)
-                if self.nif() > 1: out +=  ' IF[%d] ' % (j)
-                if self.npol() > 1: out +=  ' Pol[%d] ' % (k)
+                if self.nbeam() > 1: out +=  ' Beam[%d] ' % (beamSel)
+                if self.nif() > 1: out +=  ' IF[%d] ' % (IFSel)
+                if self.npol() > 1: out +=  ' Pol[%d] ' % (polSel)
                 out += '= %3.3f\n' % (statval[l])
                 out +=  "--------------------------------------------------\n"
@@ -277 +280 @@
             return retval
 
-    def stddev(self,mask=None, all=None):
+    def stddev(self,mask=None, allaxes=None):
         """
         Determine the standard deviation of the current beam/if/pol
@@ -285 +288 @@
             mask:    an optional mask specifying where the standard
                      deviation should be determined.
-            all:     optional flag to show all or a cursor selected
+            allaxes: optional flag to show all or a cursor selected
                      spectrum of Beam/IF/Pol. Default is all or taken
                      from .asaprc
@@ -294 +297 @@
             scan.stddev(mask=m)
         """
-        if all is None: all = rcParams['scantable.allaxes']
-        return self.stats(stat='stddev',mask=mask, all=all);
-
-    def get_tsys(self, all=None):
+        if allaxes is None: allaxes = rcParams['scantable.allaxes']
+        return self.stats(stat='stddev',mask=mask, allaxes=allaxes);
+
+    def get_tsys(self, allaxes=None):
         """
         Return the System temperatures.
         Parameters:
-            all:    optional parameter to get the Tsys values for all
-                    Beams/IFs/Pols (default) or just the one selected
-                    with scantable.set_cursor()
-                    [True or False]
+           allaxes:     if True apply to all spectra. Otherwise
+                        apply only to the selected (beam/pol/if)spectra only.
+                        The default is taken from .asaprc (True if none)
         Returns:
             a list of Tsys values.
         """
-        if all is None: all = rcParams['scantable.allaxes']
+        if allaxes is None: allaxes = rcParams['scantable.allaxes']
         from numarray import array,zeros,Float
         axes = ['Beam','IF','Pol','Time']
 
-        if all:
+        if allaxes:
             n = self.nbeam()*self.nif()*self.npol()*self.nrow()
             shp = [self.nbeam(),self.nif(),self.npol(),self.nrow()]
@@ -585 +587 @@
         return
 
-    def rotate_xyphase (self, angle, all=None):
+    def rotate_xyphase (self, angle, allaxes=None):
         """
         Rotate the phase of the XY correlation.  This is done in situ
@@ -592 +594 @@
         Parameters:
             angle:   The angle (degrees) to rotate (add) by.
-            all:     if true operate on all axes (default or .asaprc) rather
-                     than the cursor selected spectrum of Beam/IF
+            allaxes: If True apply to all spectra. Otherwise
+                     apply only to the selected (beam/pol/if)spectra only.
+                     The default is taken from .asaprc (True if none)
         Examples:
             scan.rotate_xyphase(2.3)
         """
-        if all is None: all = rcParams['scantable.allaxes']
-        sdtable._rotate_xyphase(self, angle, all)
+        if allaxes is None: allaxes = rcParams['scantable.allaxes']
+        sdtable._rotate_xyphase(self, angle, allaxes)
             
     def plot(self, what='spectrum',col='Pol', panel=None):