Changeset 113 for trunk/python/scantable.py

Timestamp:

12/01/04 11:29:39 (20 years ago)

Author:

mar637

Message:

version 0.1a

File:

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

trunk/python/scantable.py

@@ -7 +7 @@
         The ASAP container for scans
     """
-    def functions(self):
-        return ['copy','get_scan','summary','rms','set_unit','create_mask']
-
+    
     def __init__(self, filename):
         """
@@ -18 +16 @@
                          scantable
         """
+        self._vb = True
+        self._p = None
         sdtable.__init__(self, filename)
-        self._unit = 'channel'
+
+    def _verbose(self, *args):
+        """
+        Set the verbose level True or False, to indicate if output
+        should be printed as well as returned.
+        """
+        if type(args[0]) is bool:
+            self._vb = args[0]
+            return
+        elif len(args) == 0:
+            return self._vb
+
 
     def copy(self):
@@ -25 +36 @@
         Return a copy of this scantable.
         Parameters:
-
+            none
         Example:
             copiedscan = scan.copy()
         """
-        sd = sdtable._copy(self)
-        return scantable(sd)
+        sd = scantable(sdtable._copy(self))
+        return sd
+
     def get_scan(self, scanid=None):
         """
@@ -38 +50 @@
             scanid:    a scanno or a source name
         Example:
-            scan.getscan('323p459')
+            scan.get_scan('323p459')
             # gets all scans containing the source '323p459'
         """
@@ -45 +57 @@
         try:
             if type(scanid) is str:
-                s = sdtable.getsource(self,scanid)
+                s = sdtable._getsource(self,scanid)
                 return scantable(s)
             elif type(scanid) is int:
-                s = sdtable.getscan(self,scanid)
+                s = sdtable._getscan(self,scanid)
                 return scantable(s)
         except RuntimeError:
@@ -86 +98 @@
 
     def get_selection(self):
+        """
+        Return/print a the current 'cursor' into the Beam/IF/Pol cube.
+        Parameters:
+            none
+        Returns:
+            a list of values (currentBeam,currentIF,currentPol)
+        Example:
+            none
+        """
         i = self.getbeam()
         j = self.getif()
         k = self.getpol()
-        out = 'Beam=%d IF=%d Pol=%d '% (i,j,k)
-        print out
+        if self._vb:
+            out = 'Beam=%d IF=%d Pol=%d '% (i,j,k)
+            print out
         return i,j,k
 
@@ -105 +127 @@
 
         Example:
-            scan.setuint('channel')
+            scan.set_unit('channel')
             msk = scan.create_mask([100,200],[500,600])
             scan.rms(mask=m)
@@ -124 +146 @@
                         tmp.append(rmsval)
                         out += 'Beam[%d], IF[%d], Pol[%d] = %3.3f\n' % (i,j,k,rmsval)
-            print out
+            if self._vb:
+                print out
             return tmp
 
@@ -133 +156 @@
             rmsval = _rms(self,mask)
             out = 'Beam[%d], IF[%d], Pol[%d] = %3.3f' % (i,j,k,rmsval)
-            print out
+            if self._vb:
+                print out
             return rmsval
 
     def get_tsys(self, all=True):
+        """
+        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_selection()
+                    [True or False]
+        Returns:
+            a list of Tsys values.
+        """
         if all:
             tmp = []
@@ -146 +180 @@
                     for k in range(self.npol()):
                         self.setpol(k)
-                        ts = self.gettsys()
+                        ts = self._gettsys()
                         tmp.append(ts)
                         out += 'TSys: Beam[%d], IF[%d], Pol[%d] = %3.3f\n' % (i,j,k,ts)
-            print out
+            if self._vb:
+                print out
             return tmp
         else:
@@ -155 +190 @@
             j = self.getif()
             k = self.getpol()
-            ts = self.gettsys()
+            ts = self._gettsys()
             out = 'TSys: Beam[%d], IF[%d], Pol[%d] = %3.3f' % (i,j,k,ts)
-            print out
+            if self._vb:
+                print out
             return ts
+        
+    def get_time(self):
+        """
+        Get a list of time stamps for the observations.
+        Return a string for each intergration in the scantable.
+        Parameters:
+            none
+        Example:
+            none
+        """
+        out = []
+        for i in range(self.nrow()):
+            out.append(self._gettime(i))
+        return out
 
     def set_unit(self, unit='channel'):
@@ -165 +215 @@
         Parameters:
             unit:    optional unit, default is 'channel'
-                     one of 'GHz','MHz','km/s','channel'
-        """
-        units = ['GHz','MHz','km/s','channel','pixel','']
-        if unit in units:
-            if unit in ['','pixel']:
-                unit = 'channel'
-            self._unit = unit
+                     one of '*Hz','km/s','channel', ''
+        """
+
+        if unit in ['','pixel', 'channel']:
+            unit = ''
+        inf = list(self._getcoordinfo())
+        inf[0] = unit
+        self._setcoordinfo(inf)
+        if self._p: self.plot()
+
+    def set_freqframe(self, frame='LSRK'):
+        """
+        Set the frame type of the Spectral Axis.
+        Parameters:
+            frame:   an optional frame type, default 'LSRK'.
+        Examples:
+            scan.set_freqframe('BARY')
+        """
+        valid = ['REST','TOPO','LSRD','LSRK','BARY', \
+                   'GEO','GALACTO','LGROUP','CMB']
+        if frame in valid:
+            inf = list(self._getcoordinfo())
+            inf[1] = frame
+            self._setcoordinfo(inf)
         else:
-            print "Invalid unit given, please use one of:"
-            print units
-
-    def create_mask(self, *args):
+            print "Please specify a valid freq type. Valid types are:\n",valid
+            
+    def get_unit(self):
+        """
+        Get the default unit set in this scantable
+        Parameters:
+        Returns:
+            A unit string
+        """
+        inf = self._getcoordinfo()
+        unit = inf[0]
+        if unit == '': unit = 'channel'
+        return unit
+
+    def get_abscissa(self, rowno=0):
+        """
+        Get the abscissa in the current coordinate setup for the currently
+        selected Beam/IF/Pol
+        Parameters:
+            none
+        Returns:
+            The abscissa values and it's format string.
+        """
+        absc = self.getabscissa(rowno)
+        lbl = self.getabscissalabel(rowno)
+        return absc, lbl
+
+    def create_mask(self, *args, **kwargs):
         """
         Compute and return a mask based on [min,max] windows.
+        The specified windows are to be EXCLUDED, when the mask is
+        applied.
         Parameters:
             [min,max],[min2,max2],...
                 Pairs of start/end points specifying the regions
                 to be masked
-        Example:
-            scan.setunit('channel')
+            invert:     return an inverted mask, i.e. the regions
+                        specified are not masked (INCLUDED)
+        Example:
+            scan.set_unit('channel')
+
+            a)
             msk = scan.set_mask([400,500],[800,900])
-            masks the regions between 400 and 500
-            and 800 and 900 in the unit 'channel'
-        """
-        print "The current mask window unit is", self._unit
+            # masks the regions between 400 and 500
+            # and 800 and 900 in the unit 'channel'
+
+            b)
+            msk = scan.set_mask([400,500],[800,900], invert=True)
+            # masks the regions outside 400 and 500
+            # and 800 and 900 in the unit 'channel'
+           
+        """
+        u = self._getcoordinfo()[0]
+        if self._vb:
+            if u == "": u = "channel"
+            print "The current mask window unit is", u
         n = self.nchan()
-        if self._unit == 'channel':
-            data = range(n)
-        else:
-            data = self.getabscissa(unit=self._unit)
+        data = self.getabscissa()
         msk = ones(n)
         for  window in args:
@@ -201 +304 @@
                 return
             for i in range(n):
-                if data[i] > window[0] and data[i] < window[1]:
+                if data[i] >= window[0] and data[i] < window[1]:
                     msk[i] = 0
+        if kwargs.has_key('invert'):
+            if kwargs.get('invert'):
+                from numarray import logical_not
+                msk = logical_not(msk)
         return msk
-    def set_restfrequencies(self, freqs, unit='Hz'):
+    
+    def set_restfreqs(self, freqs, unit='Hz'):
         """
         Set the restfrequency(s) for this scantable.
@@ -211 +319 @@
             unit:     optional 'unit', default 'Hz'
         Example:
-            scan.set_restfrequencies([1000000000.0])
-        """
-        self.setrestfreqs(freqs, unit)
+            scan.set_restfreqs([1000000000.0])
+        """
+        if type(freqs) is float or int:
+            freqs = (freqs)
+        sdtable._setrestfreqs(self,freqs, unit)
         return
 
@@ -236 +346 @@
             print "Please specify a valid (Beam/IF/Pol)"
         return
+
+    def plot(self, what='spectrum',col='Pol', panel=None):
+        """
+        Plot the spectra contained in the scan. Alternatively you can also
+        Plot Tsys vs Time
+        Parameters:
+            what:     a choice of 'spectrum' (default) or 'tsys'
+            col:      which out of Beams/IFs/Pols should be colour stacked
+            panel:    set up multiple panels, currently not working.
+        """
+        validcol = {'Beam':self.nbeam(),'IF':self.nif(),'Pol':self.npol()}
+        validyax = ['spectrum','tsys']
+        if not self._p:
+            from asap.asaplot import ASAPlot
+            self._p = ASAPlot()
+#            print "Plotting not enabled"
+#            return
+        npan = 1
+        x = None
+        if what == 'tsys':
+            n = self.nrow()
+            if n < 2:
+                print "Only one integration. Can't plot."
+                return
+        if panel == 'Time':
+            npan = self.nrow()
+        self._p.hold()
+        self._p.clear()
+        xlab,ylab,tlab = None,None,None
+        vb = self._verbose
+        self._verbose(False)
+        sel = self.get_selection()
+        for i in range(npan):
+            for j in range(validcol[col]):
+                x = None
+                y = None
+                m = None
+                tlab = self._getsourcename(i)
+                if col == 'Beam':
+                    self.setbeam(j)
+                elif col == 'IF':
+                    self.setif(j)
+                elif col == 'Pol':
+                    self.setpol(j)
+                if what == 'tsys':
+                    x = range(self.nrow())
+                    xlab = 'Time [pixel]'
+                    m = list(ones(len(x)))
+                    y = []
+                    ylab = r'$T_{sys}$'
+                    for k in range(len(x)):
+                        y.append(self._gettsys(k))
+                else:
+                    x,xlab = self.get_abscissa(i)
+                    y = self.getspectrum(i)
+                    ylab = r'Flux'
+                    m = self.getmask(i)
+                llab = col+' '+str(j)
+                self._p.set_line(label=llab)
+                self._p.plot(x,y,m)
+        self._p.set_axes('xlabel',xlab)
+        self._p.set_axes('ylabel',ylab)
+        self._p.set_axes('title',tlab)
+        self._p.release()
+        self.set_selection(sel[0],sel[1],sel[2])
+        self._verbose(vb)
+        return