Changeset 800 for branches/Release12/python/scantable.py

Timestamp:

01/10/06 15:11:58 (18 years ago)

Author:

mar637

Message:

Request: added channel based flagging

File:

• branches/Release12/python/scantable.py (modified) (3 diffs)

branches/Release12/python/scantable.py

@@ -721 +721 @@
 
 
-    def flag_spectrum(self, thebeam, theif, thepol):
+    def flag_spectrum(self, flags, row=-1, allaxes=None):
         """
         This flags a selected spectrum in the scan 'for good'.
@@ -727 +727 @@
         Use masks for non-permanent exclusion of channels.
         Parameters:
-            thebeam,theif,thepol:    all have to be explicitly
-                                     specified
-        Example:
-            scan.flag_spectrum(0,0,1)
-            flags the spectrum for Beam=0, IF=0, Pol=1
-        """
-        if (thebeam < self.nbeam() and
-            theif < self.nif() and
-            thepol < self.npol()):
-            sdtable.setbeam(self, thebeam)
-            sdtable.setif(self, theif)
-            sdtable.setpol(self, thepol)
-            sdtable._flag(self)
-            self._add_history("flag_spectrum", vars())
-        else:
-            print "Please specify a valid (Beam/IF/Pol)"
+            flags:   a mask created with scantable.create_mask
+            row:     the number of the row (intergration) to flag,
+                     the deafult is -1, which is ALL rows.
+            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.flag_spectrum() # flags everything, not very useful
+            msk = scan.create_mask([511,513])
+            scan,set_cursor(IF=1)
+            scan.flag_spectrum(msk, allaxes=False)
+            # flags the central three channels for all rows in the table,
+            # using the selected IF only (e.g. a birdie)
+        """
+        if allaxes is None: allaxes = rcParams['scantable.allaxes']
+        if len(flags) != self.nchan():
+            msg  = "Length of mask invalid.",valid
+            if rcParams['verbose']:
+                print msg
+                return
+            else:
+                raise AssertionError(msg)
+        rows = range(self.nrow())
+        if row > -1: rows = [row]
+        for r in rows:
+            if allaxes:
+                beamSel,IFSel,polSel = (self.getbeam(),self.getif(),self.getpol())
+                for i in range(self.nbeam()):
+                    self.setbeam(i)
+                    for j in range(self.nif()):
+                        self.setif(j)
+                        for k in range(self.npol()):
+                            self.setpol(k)
+                            sdtable._flagspectrum(self, flags, r)
+                self.setbeam(beamSel)
+                self.setif(IFSel)
+                self.setpol(polSel)
+            else:
+                sdtable._flagspectrum(self, flags, r)
+        self._add_history("flag_spectrum", vars())
         return
 
@@ -840 +864 @@
                          Otherwise, the scaling is done in-situ
                          The default is taken from .asaprc (False)
-            allaxes:         if True apply to all spectra. Otherwise
+            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)