source: trunk/python/asapplotter.py @ 2954

Last change on this file since 2954 was 2953, checked in by Kana Sugimoto, 10 years ago

New Development: Yes

JIRA Issue: Yes (CAS-6595)

Ready for Test: Yes

Interface Changes: No

What Interface Changed: Please list interface changes

Test Programs:

Put in Release Notes: Yes

Module(s): sdplot, asapplotter

Description: Proper handling of flagged data in plottp, plotazel, and plotpointing2


  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 78.1 KB
RevLine 
[1824]1from asap.parameters import rcParams
2from asap.selector import selector
3from asap.scantable import scantable
[1862]4from asap.logging import asaplog, asaplog_post_dec
[1153]5import matplotlib.axes
[1556]6from matplotlib.font_manager import FontProperties
7from matplotlib.text import Text
[2535]8from matplotlib import _pylab_helpers
[1556]9
[1317]10import re
[203]11
[2150]12def new_asaplot(visible=None,**kwargs):
13    """
14    Returns a new asaplot instance based on the backend settings.
15    """
16    if visible == None:
17        visible = rcParams['plotter.gui']
18
19    backend=matplotlib.get_backend()
20    if not visible:
21        from asap.asaplot import asaplot
22    elif backend == 'TkAgg':
23        from asap.asaplotgui import asaplotgui as asaplot
24    elif backend == 'Qt4Agg':
25        from asap.asaplotgui_qt4 import asaplotgui as asaplot
26    elif backend == 'GTkAgg':
27        from asap.asaplotgui_gtk import asaplotgui as asaplot
28    else:
29        from asap.asaplot import asaplot
30    return asaplot(**kwargs)
31
[203]32class asapplotter:
[226]33    """
34    The ASAP plotter.
35    By default the plotter is set up to plot polarisations
36    'colour stacked' and scantables across panels.
[1858]37
38    .. note::
39
[226]40        Currenly it only plots 'spectra' not Tsys or
41        other variables.
[1858]42
[226]43    """
[1563]44    def __init__(self, visible=None , **kwargs):
[734]45        self._visible = rcParams['plotter.gui']
46        if visible is not None:
47            self._visible = visible
[2451]48        self._plotter = None
49        self._inikwg = kwargs
[710]50
[2699]51        ### plot settings
[2698]52        self._colormap = None
53        self._linestyles = None
54        self._fp = FontProperties()
55        self._rows = None
56        self._cols = None
57        self._minmaxx = None
58        self._minmaxy = None
59        self._margins = self.set_margin(refresh=False)
60        self._legendloc = None
[2699]61        ### scantable plot settings
[2704]62        self._plotmode = "spectra"
[554]63        self._panelling = None
64        self._stacking = None
65        self.set_panelling()
66        self.set_stacking()
[2698]67        self._hist = rcParams['plotter.histogram']
[2699]68        ### scantable dependent settings
[203]69        self._data = None
[2698]70        self._abcunit = None
71        self._headtext = {'string': None, 'textobj': None}
72        self._selection = selector()
73        self._usermask = []
74        self._maskselection = None
75        self._offset = None
[607]76        self._lmap = None
[226]77        self._title = None
[257]78        self._ordinate = None
79        self._abcissa = None
[2699]80        ### cursors for page iteration
[1981]81        self._startrow = 0
82        self._ipanel = -1
83        self._panelrows = []
[1023]84
[920]85    def _translate(self, instr):
[1910]86        keys = "s b i p t r".split()
[920]87        if isinstance(instr, str):
88            for key in keys:
89                if instr.lower().startswith(key):
90                    return key
91        return None
92
[2535]93    @asaplog_post_dec
[2451]94    def _reload_plotter(self):
95        if self._plotter is not None:
[2535]96            #if not self._plotter.is_dead:
97            #    # clear lines and axes
98            #    try:
99            #        self._plotter.clear()
100            #    except: # Can't remove when already killed.
101            #        pass
[2451]102            if self.casabar_exists():
103                del self._plotter.figmgr.casabar
104            self._plotter.quit()
105            del self._plotter
[2535]106        asaplog.push('Loading new plotter')
[2451]107        self._plotter = new_asaplot(self._visible,**self._inikwg)
108        self._plotter.figmgr.casabar=self._new_custombar()
109        # just to make sure they're set
110        self._plotter.palette(color=0,colormap=self._colormap,
111                              linestyle=0,linestyles=self._linestyles)
112        self._plotter.legend(self._legendloc)
[710]113
[2714]114    ### TODO: it's probably better to define following two methods in
115    ###       backend dependent class.
[2173]116    def _new_custombar(self):
[1819]117        backend=matplotlib.get_backend()
[2168]118        if not self._visible:
119            return None
120        elif backend == "TkAgg":
[2155]121            from asap.customgui_tkagg import CustomToolbarTkAgg
[1819]122            return CustomToolbarTkAgg(self)
[2168]123        elif backend == "Qt4Agg":
124            from asap.customgui_qt4agg import CustomToolbarQT4Agg
125            return CustomToolbarQT4Agg(self)
[1995]126        return None
[1819]127
[2147]128    def casabar_exists(self):
129        if not hasattr(self._plotter.figmgr,'casabar'):
130            return False
131        elif self._plotter.figmgr.casabar:
132            return True
133        return False
[2714]134    ### end of TODO
[2147]135
[2453]136    def _assert_plotter(self,action="status",errmsg=None):
[2451]137        """
[2453]138        Check plot window status. Returns True if plot window is alive.
[2451]139        Parameters
[2453]140            action:    An action to take if the plotter window is not alive.
141                       ['status'|'reload'|'halt']
142                       The action 'status' simply returns False if asaplot
143                       is not alive. When action='reload', plot window is
144                       reloaded and the method returns True. Finally, an
145                       error is raised when action='halt'.
[2451]146            errmsg:    An error (warning) message to send to the logger,
[2453]147                       when plot window is not alive.
[2451]148        """
[2538]149        isAlive = (self._plotter is not None) and self._plotter._alive()
[2535]150        # More tests
[2538]151        #if isAlive:
152        #    if self._plotter.figmgr:
153        #        figmgr = self._plotter.figmgr
154        #        figid = figmgr.num
155        #        # Make sure figid=0 is what asapplotter expects.
156        #        # It might be already destroied/overridden by matplotlib
157        #        # commands or other plotting methods using asaplot.
158        #        isAlive = _pylab_helpers.Gcf.has_fignum(figid) and \
159        #                  (figmgr == \
160        #                   _pylab_helpers.Gcf.get_fig_manager(figid))
161        #    else:
162        #        isAlive = False
[2535]163           
164        if isAlive:
[2451]165            return True
166        # Plotter is not alive.
167        haltmsg = "Plotter window has not yet been loaded or is closed."
168        if type(errmsg)==str and len(errmsg) > 0:
169            haltmsg = errmsg
170       
[2453]171        if action.upper().startswith("R"):
[2451]172            # reload plotter
173            self._reload_plotter()
174            return True
[2453]175        elif action.upper().startswith("H"):
[2451]176            # halt
177            asaplog.push(haltmsg)
178            asaplog.post("ERROR")
179            raise RuntimeError(haltmsg)
180        else:
181            if errmsg:
182                asaplog.push(errmsg)
183                asaplog.post("WARN")
184            return False
185
186
[1572]187    def gca(self):
[2451]188        errmsg = "No axis to retun. Need to plot first."
[2453]189        if not self._assert_plotter(action="status",errmsg=errmsg):
[2451]190            return None
[1572]191        return self._plotter.figure.gca()
192
[1550]193    def refresh(self):
[1572]194        """Do a soft refresh"""
[2451]195        errmsg = "No figure to re-plot. Need to plot first."
[2453]196        self._assert_plotter(action="halt",errmsg=errmsg)
[2451]197
[1550]198        self._plotter.figure.show()
199
[2698]200    def save(self, filename=None, orientation=None, dpi=None):
201        """
202        Save the plot to a file. The known formats are 'png', 'ps', 'eps'.
203        Parameters:
204             filename:    The name of the output file. This is optional
205                          and autodetects the image format from the file
206                          suffix. If non filename is specified a file
207                          called 'yyyymmdd_hhmmss.png' is created in the
208                          current directory.
209             orientation: optional parameter for postscript only (not eps).
210                          'landscape', 'portrait' or None (default) are valid.
211                          If None is choosen for 'ps' output, the plot is
212                          automatically oriented to fill the page.
213             dpi:         The dpi of the output non-ps plot
214        """
215        errmsg = "Cannot save figure. Need to plot first."
216        self._assert_plotter(action="halt",errmsg=errmsg)
217       
218        self._plotter.save(filename,orientation,dpi)
219        return
220
[1555]221    def create_mask(self, nwin=1, panel=0, color=None):
[1597]222        """
[1927]223        Interactively define a mask. It retruns a mask that is equivalent to
[1597]224        the one created manually with scantable.create_mask.
225        Parameters:
226            nwin:       The number of mask windows to create interactively
227                        default is 1.
228            panel:      Which panel to use for mask selection. This is useful
229                        if different IFs are spread over panels (default 0)
230        """
[2451]231        ## this method relies on already plotted figure
[2453]232        if not self._assert_plotter(action="status") or (self._data is None):
[2451]233            msg = "Cannot create mask interactively on plot. Can only create mask after plotting."
234            asaplog.push( msg )
235            asaplog.post( "ERROR" )
[1555]236            return []
[1547]237        outmask = []
[1549]238        self._plotter.subplot(panel)
239        xmin, xmax = self._plotter.axes.get_xlim()
[1548]240        marg = 0.05*(xmax-xmin)
[1549]241        self._plotter.axes.set_xlim(xmin-marg, xmax+marg)
[1550]242        self.refresh()
[1695]243
[1555]244        def cleanup(lines=False, texts=False, refresh=False):
245            if lines:
246                del self._plotter.axes.lines[-1]
247            if texts:
248                del self._plotter.axes.texts[-1]
249            if refresh:
250                self.refresh()
251
252        for w in xrange(nwin):
[1547]253            wpos = []
[1695]254            self.text(0.05,1.0, "Add start boundary",
[1555]255                      coords="relative", fontsize=10)
256            point = self._plotter.get_point()
257            cleanup(texts=True)
258            if point is None:
259                continue
260            wpos.append(point[0])
[1695]261            self.axvline(wpos[0], color=color)
[1551]262            self.text(0.05,1.0, "Add end boundary", coords="relative", fontsize=10)
[1555]263            point = self._plotter.get_point()
264            cleanup(texts=True, lines=True)
265            if point is None:
266                self.refresh()
267                continue
268            wpos.append(point[0])
269            self.axvspan(wpos[0], wpos[1], alpha=0.1,
270                         edgecolor=color, facecolor=color)
271            ymin, ymax = self._plotter.axes.get_ylim()
[1547]272            outmask.append(wpos)
[1153]273
[1555]274        self._plotter.axes.set_xlim(xmin, xmax)
275        self.refresh()
276        if len(outmask) > 0:
277            return self._data.create_mask(*outmask)
278        return []
279
[2699]280
[2714]281    ### Forwards to methods in matplotlib axes ###
[1153]282    def text(self, *args, **kwargs):
[2453]283        self._assert_plotter(action="reload")
[1547]284        if kwargs.has_key("interactive"):
285            if kwargs.pop("interactive"):
286                pos = self._plotter.get_point()
287                args = tuple(pos)+args
[1153]288        self._axes_callback("text", *args, **kwargs)
[1547]289
[1358]290    text.__doc__ = matplotlib.axes.Axes.text.__doc__
[1559]291
[1153]292    def arrow(self, *args, **kwargs):
[2453]293        self._assert_plotter(action="reload")
[1547]294        if kwargs.has_key("interactive"):
295            if kwargs.pop("interactive"):
296                pos = self._plotter.get_region()
297                dpos = (pos[0][0], pos[0][1],
298                        pos[1][0]-pos[0][0],
299                        pos[1][1] - pos[0][1])
300                args = dpos + args
[1153]301        self._axes_callback("arrow", *args, **kwargs)
[1547]302
[1358]303    arrow.__doc__ = matplotlib.axes.Axes.arrow.__doc__
[1559]304
305    def annotate(self, text, xy=None, xytext=None, **kwargs):
[2453]306        self._assert_plotter(action="reload")
[1559]307        if kwargs.has_key("interactive"):
308            if kwargs.pop("interactive"):
309                xy = self._plotter.get_point()
310                xytext = self._plotter.get_point()
311        if not kwargs.has_key("arrowprops"):
312            kwargs["arrowprops"] = dict(arrowstyle="->")
313        self._axes_callback("annotate", text, xy, xytext, **kwargs)
314
315    annotate.__doc__ = matplotlib.axes.Axes.annotate.__doc__
316
[1153]317    def axvline(self, *args, **kwargs):
[2453]318        self._assert_plotter(action="reload")
[1547]319        if kwargs.has_key("interactive"):
320            if kwargs.pop("interactive"):
321                pos = self._plotter.get_point()
322                args = (pos[0],)+args
[1153]323        self._axes_callback("axvline", *args, **kwargs)
[1559]324
[1358]325    axvline.__doc__ = matplotlib.axes.Axes.axvline.__doc__
[1547]326
[1153]327    def axhline(self, *args, **kwargs):
[2453]328        self._assert_plotter(action="reload")
[1547]329        if kwargs.has_key("interactive"):
330            if kwargs.pop("interactive"):
331                pos = self._plotter.get_point()
332                args = (pos[1],)+args
[1153]333        self._axes_callback("axhline", *args, **kwargs)
[1559]334
[1358]335    axhline.__doc__ = matplotlib.axes.Axes.axhline.__doc__
[1547]336
[1153]337    def axvspan(self, *args, **kwargs):
[2453]338        self._assert_plotter(action="reload")
[1547]339        if kwargs.has_key("interactive"):
340            if kwargs.pop("interactive"):
341                pos = self._plotter.get_region()
342                dpos = (pos[0][0], pos[1][0])
343                args = dpos + args
[1153]344        self._axes_callback("axvspan", *args, **kwargs)
345        # hack to preventy mpl from redrawing the patch
346        # it seem to convert the patch into lines on every draw.
347        # This doesn't happen in a test script???
[1547]348        #del self._plotter.axes.patches[-1]
349
[1358]350    axvspan.__doc__ = matplotlib.axes.Axes.axvspan.__doc__
[1232]351
[1153]352    def axhspan(self, *args, **kwargs):
[2453]353        self._assert_plotter(action="reload")
[1547]354        if kwargs.has_key("interactive"):
355            if kwargs.pop("interactive"):
356                pos = self._plotter.get_region()
357                dpos = (pos[0][1], pos[1][1])
358                args = dpos + args
[1232]359        self._axes_callback("axhspan", *args, **kwargs)
[1153]360        # hack to preventy mpl from redrawing the patch
361        # it seem to convert the patch into lines on every draw.
362        # This doesn't happen in a test script???
[1547]363        #del self._plotter.axes.patches[-1]
[1559]364
[1358]365    axhspan.__doc__ = matplotlib.axes.Axes.axhspan.__doc__
[1153]366
367    def _axes_callback(self, axesfunc, *args, **kwargs):
[2453]368        self._assert_plotter(action="reload")
[1153]369        panel = 0
370        if kwargs.has_key("panel"):
371            panel = kwargs.pop("panel")
372        coords = None
373        if kwargs.has_key("coords"):
374            coords = kwargs.pop("coords")
375            if coords.lower() == 'world':
376                kwargs["transform"] = self._plotter.axes.transData
377            elif coords.lower() == 'relative':
378                kwargs["transform"] = self._plotter.axes.transAxes
379        self._plotter.subplot(panel)
380        self._plotter.axes.set_autoscale_on(False)
381        getattr(self._plotter.axes, axesfunc)(*args, **kwargs)
382        self._plotter.show(False)
383        self._plotter.axes.set_autoscale_on(True)
384    # end matplotlib.axes fowarding functions
385
[2699]386
387    ### Forwards to matplotlib.Figure.text ###
[2698]388    def figtext(self, *args, **kwargs):
389        """
390        Add text to figure at location x,y (relative 0-1 coords).
391        This method forwards *args and **kwargs to a Matplotlib method,
392        matplotlib.Figure.text.
393        See the method help for detailed information.
394        """
395        self._assert_plotter(action="reload")
396        self._plotter.text(*args, **kwargs)
397    # end matplotlib.Figure.text forwarding function
398
[2699]399
400    ### Set Plot parameters ###
[1862]401    @asaplog_post_dec
[1819]402    def set_data(self, scan, refresh=True):
403        """
[1824]404        Set a scantable to plot.
[1819]405        Parameters:
406            scan:      a scantable
407            refresh:   True (default) or False. If True, the plot is
[1824]408                       replotted based on the new parameter setting(s).
[1819]409                       Otherwise,the parameter(s) are set without replotting.
410        Note:
411           The user specified masks and data selections will be reset
412           if a new scantable is set. This method should be called before
[1824]413           setting data selections (set_selection) and/or masks (set_mask).
[1819]414        """
415        from asap import scantable
416        if isinstance(scan, scantable):
[2604]417            if (self._data is not None) and (scan != self._data):
418                del self._data
419                msg = "A new scantable is set to the plotter. "\
[2714]420                      "The masks, data selections, and labels are reset."
421                asaplog.push(msg)
[2604]422            self._data = scan
423            # reset
424            self._reset()
[1819]425        else:
426            msg = "Input is not a scantable"
427            raise TypeError(msg)
[1547]428
[1819]429        # ranges become invalid when unit changes
430        if self._abcunit and self._abcunit != self._data.get_unit():
431            self._minmaxx = None
432            self._minmaxy = None
433            self._abcunit = self._data.get_unit()
434        if refresh: self.plot()
435
[1862]436    @asaplog_post_dec
[1819]437    def set_mode(self, stacking=None, panelling=None, refresh=True):
[203]438        """
[377]439        Set the plots look and feel, i.e. what you want to see on the plot.
[203]440        Parameters:
441            stacking:     tell the plotter which variable to plot
[1217]442                          as line colour overlays (default 'pol')
[203]443            panelling:    tell the plotter which variable to plot
444                          across multiple panels (default 'scan'
[1819]445            refresh:      True (default) or False. If True, the plot is
[1824]446                          replotted based on the new parameter setting(s).
[1819]447                          Otherwise,the parameter(s) are set without replotting.
[203]448        Note:
449            Valid modes are:
450                 'beam' 'Beam' 'b':     Beams
451                 'if' 'IF' 'i':         IFs
452                 'pol' 'Pol' 'p':       Polarisations
453                 'scan' 'Scan' 's':     Scans
454                 'time' 'Time' 't':     Times
[1989]455                 'row' 'Row' 'r':       Rows
456            When either 'stacking' or 'panelling' is set to 'row',
457            the other parameter setting is ignored.
[203]458        """
[753]459        msg = "Invalid mode"
460        if not self.set_panelling(panelling) or \
461               not self.set_stacking(stacking):
[1859]462            raise TypeError(msg)
[1989]463        #if self._panelling == 'r':
464        #    self._stacking = '_r'
465        #if self._stacking == 'r':
466        #    self._panelling = '_r'
[1819]467        if refresh and self._data: self.plot(self._data)
[203]468        return
469
[2698]470    def set_stacking(self, what=None):
471        """Set the 'stacking' mode i.e. which type of spectra should be
472        overlayed.
473        """
474        mode = what
475        if mode is None:
476             mode = rcParams['plotter.stacking']
477        md = self._translate(mode)
478        if md:
479            self._stacking = md
480            self._lmap = None
481            # new mode is set. need to reset counters for multi page plotting
482            self._reset_counters()
483            return True
484        return False
485
[554]486    def set_panelling(self, what=None):
[1858]487        """Set the 'panelling' mode i.e. which type of spectra should be
488        spread across different panels.
489        """
490
[554]491        mode = what
492        if mode is None:
493             mode = rcParams['plotter.panelling']
494        md = self._translate(mode)
[203]495        if md:
[554]496            self._panelling = md
[226]497            self._title = None
[2698]498            # new mode is set. need to reset counters for multi page plotting
[1981]499            self._reset_counters()
[203]500            return True
501        return False
502
[1819]503    def set_layout(self,rows=None,cols=None,refresh=True):
[377]504        """
505        Set the multi-panel layout, i.e. how many rows and columns plots
506        are visible.
507        Parameters:
508             rows:   The number of rows of plots
509             cols:   The number of columns of plots
[1819]510             refresh:  True (default) or False. If True, the plot is
[1824]511                       replotted based on the new parameter setting(s).
[1819]512                       Otherwise,the parameter(s) are set without replotting.
[377]513        Note:
514             If no argument is given, the potter reverts to its auto-plot
515             behaviour.
516        """
517        self._rows = rows
518        self._cols = cols
[2715]519        # new layout is set. need to reset counters for multi page plotting
520        self._reset_counters()
[1819]521        if refresh and self._data: self.plot(self._data)
[377]522        return
523
[1897]524    def set_range(self,xstart=None,xend=None,ystart=None,yend=None,refresh=True, offset=None):
[203]525        """
526        Set the range of interest on the abcissa of the plot
527        Parameters:
[525]528            [x,y]start,[x,y]end:  The start and end points of the 'zoom' window
[1819]529            refresh:  True (default) or False. If True, the plot is
[1824]530                      replotted based on the new parameter setting(s).
[1819]531                      Otherwise,the parameter(s) are set without replotting.
[1897]532            offset:   shift the abcissa by the given amount. The abcissa label will
533                      have '(relative)' appended to it.
[203]534        Note:
535            These become non-sensical when the unit changes.
536            use plotter.set_range() without parameters to reset
537
538        """
[1897]539        self._offset = offset
[525]540        if xstart is None and xend is None:
541            self._minmaxx = None
[600]542        else:
543            self._minmaxx = [xstart,xend]
[525]544        if ystart is None and yend is None:
545            self._minmaxy = None
[600]546        else:
[709]547            self._minmaxy = [ystart,yend]
[1819]548        if refresh and self._data: self.plot(self._data)
[203]549        return
[709]550
[1819]551    def set_legend(self, mp=None, fontsize = None, mode = 0, refresh=True):
[203]552        """
553        Specify a mapping for the legend instead of using the default
554        indices:
555        Parameters:
[1101]556            mp:        a list of 'strings'. This should have the same length
557                       as the number of elements on the legend and then maps
558                       to the indeces in order. It is possible to uses latex
559                       math expression. These have to be enclosed in r'',
560                       e.g. r'$x^{2}$'
561            fontsize:  The font size of the label (default None)
562            mode:      where to display the legend
563                       Any other value for loc else disables the legend:
[1096]564                        0: auto
565                        1: upper right
566                        2: upper left
567                        3: lower left
568                        4: lower right
569                        5: right
570                        6: center left
571                        7: center right
572                        8: lower center
573                        9: upper center
574                        10: center
[1819]575            refresh:    True (default) or False. If True, the plot is
[1824]576                        replotted based on the new parameter setting(s).
[1819]577                        Otherwise,the parameter(s) are set without replotting.
[203]578
579        Example:
[485]580             If the data has two IFs/rest frequencies with index 0 and 1
[203]581             for CO and SiO:
582             plotter.set_stacking('i')
[710]583             plotter.set_legend(['CO','SiO'])
[203]584             plotter.plot()
[710]585             plotter.set_legend([r'$^{12}CO$', r'SiO'])
[203]586        """
587        self._lmap = mp
[2451]588        #self._plotter.legend(mode)
589        self._legendloc = mode
[1101]590        if isinstance(fontsize, int):
591            from matplotlib import rc as rcp
592            rcp('legend', fontsize=fontsize)
[1819]593        if refresh and self._data: self.plot(self._data)
[226]594        return
595
[1819]596    def set_title(self, title=None, fontsize=None, refresh=True):
[710]597        """
[2451]598        Set the title of sub-plots. If multiple sub-plots are plotted,
[710]599        multiple titles have to be specified.
[1819]600        Parameters:
[2451]601            title:      a list of titles of sub-plots.
602            fontsize:   a font size of titles (integer)
[1819]603            refresh:    True (default) or False. If True, the plot is
[1824]604                        replotted based on the new parameter setting(s).
[1819]605                        Otherwise,the parameter(s) are set without replotting.
[710]606        Example:
607             # two panels are visible on the plotter
[2451]608             plotter.set_title(['First Panel','Second Panel'])
[710]609        """
[226]610        self._title = title
[1101]611        if isinstance(fontsize, int):
612            from matplotlib import rc as rcp
613            rcp('axes', titlesize=fontsize)
[1819]614        if refresh and self._data: self.plot(self._data)
[226]615        return
616
[1819]617    def set_ordinate(self, ordinate=None, fontsize=None, refresh=True):
[710]618        """
619        Set the y-axis label of the plot. If multiple panels are plotted,
620        multiple labels have to be specified.
[1021]621        Parameters:
622            ordinate:    a list of ordinate labels. None (default) let
623                         data determine the labels
[2451]624            fontsize:    a font size of vertical axis labels (integer)
[1819]625            refresh:     True (default) or False. If True, the plot is
[1824]626                         replotted based on the new parameter setting(s).
[1819]627                         Otherwise,the parameter(s) are set without replotting.
[710]628        Example:
629             # two panels are visible on the plotter
[2451]630             plotter.set_ordinate(['First Y-Axis','Second Y-Axis'])
[710]631        """
[257]632        self._ordinate = ordinate
[1101]633        if isinstance(fontsize, int):
634            from matplotlib import rc as rcp
635            rcp('axes', labelsize=fontsize)
636            rcp('ytick', labelsize=fontsize)
[1819]637        if refresh and self._data: self.plot(self._data)
[257]638        return
639
[1819]640    def set_abcissa(self, abcissa=None, fontsize=None, refresh=True):
[710]641        """
642        Set the x-axis label of the plot. If multiple panels are plotted,
643        multiple labels have to be specified.
[1021]644        Parameters:
645            abcissa:     a list of abcissa labels. None (default) let
646                         data determine the labels
[2451]647            fontsize:    a font size of horizontal axis labels (integer)
[1819]648            refresh:     True (default) or False. If True, the plot is
[1824]649                         replotted based on the new parameter setting(s).
[1819]650                         Otherwise,the parameter(s) are set without replotting.
[710]651        Example:
652             # two panels are visible on the plotter
[2451]653             plotter.set_ordinate(['First X-Axis','Second X-Axis'])
[710]654        """
[257]655        self._abcissa = abcissa
[1101]656        if isinstance(fontsize, int):
657            from matplotlib import rc as rcp
658            rcp('axes', labelsize=fontsize)
659            rcp('xtick', labelsize=fontsize)
[1819]660        if refresh and self._data: self.plot(self._data)
[257]661        return
662
[2700]663    def set_histogram(self, hist=True, linewidth=None, refresh=True):
664        """
665        Enable/Disable histogram-like plotting.
666        Parameters:
667            hist:        True (default) or False. The fisrt default
668                         is taken from the .asaprc setting
669                         plotter.histogram
670            linewidth:   a line width
671            refresh:     True (default) or False. If True, the plot is
672                         replotted based on the new parameter setting(s).
673                         Otherwise,the parameter(s) are set without replotting.
674        """
675        self._hist = hist
676        if isinstance(linewidth, float) or isinstance(linewidth, int):
677            from matplotlib import rc as rcp
678            rcp('lines', linewidth=linewidth)
679        if refresh and self._data: self.plot(self._data)
680
[1819]681    def set_colors(self, colmap, refresh=True):
[377]682        """
[1217]683        Set the colours to be used. The plotter will cycle through
684        these colours when lines are overlaid (stacking mode).
[1021]685        Parameters:
[1217]686            colmap:     a list of colour names
[1819]687            refresh:    True (default) or False. If True, the plot is
[1824]688                        replotted based on the new parameter setting(s).
[1819]689                        Otherwise,the parameter(s) are set without replotting.
[710]690        Example:
[2451]691             plotter.set_colors('red green blue')
[710]692             # If for example four lines are overlaid e.g I Q U V
693             # 'I' will be 'red', 'Q' will be 'green', U will be 'blue'
694             # and 'V' will be 'red' again.
695        """
[2451]696        #if isinstance(colmap,str):
697        #    colmap = colmap.split()
698        #self._plotter.palette(0, colormap=colmap)
699        self._colormap = colmap
[1819]700        if refresh and self._data: self.plot(self._data)
[710]701
[1217]702    # alias for english speakers
703    set_colours = set_colors
704
[1819]705    def set_linestyles(self, linestyles=None, linewidth=None, refresh=True):
[710]706        """
[734]707        Set the linestyles to be used. The plotter will cycle through
708        these linestyles when lines are overlaid (stacking mode) AND
709        only one color has been set.
[710]710        Parameters:
[2451]711            linestyles:      a list of linestyles to use.
[710]712                             'line', 'dashed', 'dotted', 'dashdot',
713                             'dashdotdot' and 'dashdashdot' are
714                             possible
[2451]715            linewidth:       a line width
[1819]716            refresh:         True (default) or False. If True, the plot is
[1824]717                             replotted based on the new parameter setting(s).
[1819]718                             Otherwise,the parameter(s) are set without replotting.
[710]719        Example:
[2451]720             plotter.set_colors('black')
721             plotter.set_linestyles('line dashed dotted dashdot')
[710]722             # If for example four lines are overlaid e.g I Q U V
723             # 'I' will be 'solid', 'Q' will be 'dashed',
724             # U will be 'dotted' and 'V' will be 'dashdot'.
725        """
[2451]726        #if isinstance(linestyles,str):
727        #    linestyles = linestyles.split()
728        #self._plotter.palette(color=0,linestyle=0,linestyles=linestyles)
729        self._linestyles = linestyles
[1101]730        if isinstance(linewidth, float) or isinstance(linewidth, int):
731            from matplotlib import rc as rcp
732            rcp('lines', linewidth=linewidth)
[1819]733        if refresh and self._data: self.plot(self._data)
[710]734
[1819]735    def set_font(self, refresh=True,**kwargs):
[1101]736        """
737        Set font properties.
738        Parameters:
739            family:    one of 'sans-serif', 'serif', 'cursive', 'fantasy', 'monospace'
740            style:     one of 'normal' (or 'roman'), 'italic'  or 'oblique'
741            weight:    one of 'normal or 'bold'
742            size:      the 'general' font size, individual elements can be adjusted
743                       seperately
[1819]744            refresh:   True (default) or False. If True, the plot is
[1824]745                       replotted based on the new parameter setting(s).
[1819]746                       Otherwise,the parameter(s) are set without replotting.
[1101]747        """
748        from matplotlib import rc as rcp
[1547]749        fdict = {}
750        for k,v in kwargs.iteritems():
751            if v:
752                fdict[k] = v
[1556]753        self._fp = FontProperties(**fdict)
[1819]754        if refresh and self._data: self.plot(self._data)
[1101]755
[2037]756    def set_margin(self,margin=[],refresh=True):
[1819]757        """
[2037]758        Set margins between subplots and plot edges.
[1819]759        Parameters:
[2037]760            margin:   a list of margins in figure coordinate (0-1),
[1824]761                      i.e., fraction of the figure width or height.
[1819]762                      The order of elements should be:
763                      [left, bottom, right, top, horizontal space btw panels,
[1824]764                      vertical space btw panels].
[1819]765            refresh:  True (default) or False. If True, the plot is
[1824]766                      replotted based on the new parameter setting(s).
[1819]767                      Otherwise,the parameter(s) are set without replotting.
768        Note
[2037]769        * When margin is not specified, the values are reset to the defaults
[1819]770          of matplotlib.
[1824]771        * If any element is set to be None, the current value is adopted.
[1819]772        """
[2037]773        if margin == []: self._margins=self._reset_margin()
[1824]774        else:
[2037]775            self._margins=[None]*6
776            self._margins[0:len(margin)]=margin
777        #print "panel margin set to ",self._margins
[1819]778        if refresh and self._data: self.plot(self._data)
779
[2037]780    def _reset_margin(self):
[1819]781        ks=map(lambda x: 'figure.subplot.'+x,
782               ['left','bottom','right','top','hspace','wspace'])
783        return map(matplotlib.rcParams.get,ks)
784
[1259]785    def plot_lines(self, linecat=None, doppler=0.0, deltachan=10, rotate=90.0,
[1146]786                   location=None):
787        """
[1158]788        Plot a line catalog.
789        Parameters:
790            linecat:      the linecatalog to plot
[1168]791            doppler:      the velocity shift to apply to the frequencies
[1158]792            deltachan:    the number of channels to include each side of the
793                          line to determine a local maximum/minimum
[1927]794            rotate:       the rotation (in degrees) for the text label (default 90.0)
[1158]795            location:     the location of the line annotation from the 'top',
796                          'bottom' or alternate (None - the default)
[1165]797        Notes:
798        If the spectrum is flagged no line will be drawn in that location.
[1146]799        """
[2451]800        errmsg = "Cannot plot spectral lines. Need to plot scantable first."
[2453]801        self._assert_plotter(action="halt",errmsg=errmsg)
[1259]802        if not self._data:
803            raise RuntimeError("No scantable has been plotted yet.")
[1146]804        from asap._asap import linecatalog
[1259]805        if not isinstance(linecat, linecatalog):
806            raise ValueError("'linecat' isn't of type linecatalog.")
807        if not self._data.get_unit().endswith("Hz"):
808            raise RuntimeError("Can only overlay linecatalogs when data is in frequency.")
[1739]809        from numpy import ma
[1146]810        for j in range(len(self._plotter.subplots)):
811            self._plotter.subplot(j)
812            lims = self._plotter.axes.get_xlim()
[1153]813            for row in range(linecat.nrow()):
[1259]814                # get_frequency returns MHz
815                base = { "GHz": 1000.0, "MHz": 1.0, "Hz": 1.0e-6 }
816                restf = linecat.get_frequency(row)/base[self._data.get_unit()]
[1165]817                c = 299792.458
[1174]818                freq = restf*(1.0-doppler/c)
[1146]819                if lims[0] < freq < lims[1]:
820                    if location is None:
821                        loc = 'bottom'
[1153]822                        if row%2: loc='top'
[1146]823                    else: loc = location
[1153]824                    maxys = []
825                    for line in self._plotter.axes.lines:
826                        v = line._x
827                        asc = v[0] < v[-1]
828
829                        idx = None
830                        if not asc:
831                            if v[len(v)-1] <= freq <= v[0]:
832                                i = len(v)-1
833                                while i>=0 and v[i] < freq:
834                                    idx = i
835                                    i-=1
836                        else:
837                           if v[0] <= freq <= v[len(v)-1]:
838                                i = 0
839                                while  i<len(v) and v[i] < freq:
840                                    idx = i
841                                    i+=1
842                        if idx is not None:
843                            lower = idx - deltachan
844                            upper = idx + deltachan
845                            if lower < 0: lower = 0
846                            if upper > len(v): upper = len(v)
847                            s = slice(lower, upper)
[1167]848                            y = line._y[s]
[1165]849                            maxy = ma.maximum(y)
850                            if isinstance( maxy, float):
851                                maxys.append(maxy)
[1164]852                    if len(maxys):
853                        peak = max(maxys)
[1165]854                        if peak > self._plotter.axes.get_ylim()[1]:
855                            loc = 'bottom'
[1164]856                    else:
857                        continue
[1157]858                    self._plotter.vline_with_label(freq, peak,
859                                                   linecat.get_name(row),
860                                                   location=loc, rotate=rotate)
[1153]861        self._plotter.show(hardrefresh=False)
[1146]862
[1153]863
[2698]864    def set_selection(self, selection=None, refresh=True, **kw):
[710]865        """
[377]866        Parameters:
[2698]867            selection:  a selector object (default unset the selection)
868            refresh:    True (default) or False. If True, the plot is
869                        replotted based on the new parameter setting(s).
870                        Otherwise,the parameter(s) are set without replotting.
[377]871        """
[2698]872        if selection is None:
873            # reset
874            if len(kw) == 0:
875                self._selection = selector()
876            else:
877                # try keywords
878                for k in kw:
879                    if k not in selector.fields:
880                        raise KeyError("Invalid selection key '%s', valid keys are %s" % (k, selector.fields))
881                self._selection = selector(**kw)
882        elif isinstance(selection, selector):
883            self._selection = selection
884        else:
885            raise TypeError("'selection' is not of type selector")
[709]886
[2698]887        order = self._get_sortstring([self._panelling,self._stacking])
888        if order:
889            self._selection.set_order(order)
890        if refresh and self._data:
891            self.plot()
892
[1862]893    @asaplog_post_dec
[1819]894    def set_mask(self, mask=None, selection=None, refresh=True):
[525]895        """
[734]896        Set a plotting mask for a specific polarization.
[2451]897        This is useful for masking out 'noise' Pangle outside a source.
[734]898        Parameters:
[920]899             mask:           a mask from scantable.create_mask
900             selection:      the spectra to apply the mask to.
[1819]901             refresh:        True (default) or False. If True, the plot is
[1824]902                             replotted based on the new parameter setting(s).
[1819]903                             Otherwise,the parameter(s) are set without replotting.
[734]904        Example:
[920]905             select = selector()
[2451]906             select.setpolstrings('Pangle')
[920]907             plotter.set_mask(mymask, select)
[734]908        """
[710]909        if not self._data:
[920]910            msg = "Can only set mask after a first call to plot()"
[1859]911            raise RuntimeError(msg)
[2714]912        if (mask is not None) and len(mask):
[920]913            if isinstance(mask, list) or isinstance(mask, tuple):
914                self._usermask = array(mask)
[710]915            else:
[920]916                self._usermask = mask
917        if mask is None and selection is None:
918            self._usermask = []
919            self._maskselection = None
920        if isinstance(selection, selector):
[947]921            self._maskselection = {'b': selection.get_beams(),
922                                   's': selection.get_scans(),
923                                   'i': selection.get_ifs(),
924                                   'p': selection.get_pols(),
[920]925                                   't': [] }
[710]926        else:
[920]927            self._maskselection = None
[1819]928        if refresh: self.plot(self._data)
[710]929
[709]930
[2699]931    ### Reset methods ###
[710]932    def _reset(self):
[2714]933        """Reset method called when new data is set"""
934        # reset selections and masks
935        self.set_selection(None, False)
936        self.set_mask(None, None, False)
937        # reset offset
[1897]938        self._offset = None
[2714]939        # reset header
[2051]940        self._reset_header()
[2714]941        # reset labels
942        self._lmap = None # related to stack
943        self.set_title(None, None, False)
944        self.set_ordinate(None, None, False)
945        self.set_abcissa(None, None, False)
[920]946
[2051]947    def _reset_header(self):
[2053]948        self._headtext={'string': None, 'textobj': None}
[2051]949
[2697]950    def _reset_counter(self):
951        self._startrow = 0
952        self._ipanel = -1
[2715]953        self._panelrows = []
[2697]954        self._reset_header()
955        if self.casabar_exists():
956            self._plotter.figmgr.casabar.set_pagecounter(1)
957
[2698]958    def _reset_counters(self):
959        self._startrow = 0
960        self._ipanel = -1
961        self._panelrows = []
962
[2699]963
964    ### Actual scantable plot methods ###
[2698]965    @asaplog_post_dec
966    def plot(self, scan=None):
967        """
968        Plot a scantable.
969        Parameters:
970            scan:   a scantable
971        Note:
972            If a scantable was specified in a previous call
973            to plot, no argument has to be given to 'replot'
974            NO checking is done that the abcissas of the scantable
975            are consistent e.g. all 'channel' or all 'velocity' etc.
976        """
[2704]977        self._plotmode = "spectra"
[2698]978        if not self._data and not scan:
979            msg = "Input is not a scantable"
980            raise TypeError(msg)
981
982        self._assert_plotter(action="reload")
983        self._plotter.hold()
984        self._reset_counter()
985        #self._plotter.clear()
986        if scan:
987            self.set_data(scan, refresh=False)
988        self._plotter.palette(color=0,colormap=self._colormap,
989                              linestyle=0,linestyles=self._linestyles)
990        self._plotter.legend(self._legendloc)
991        self._plot(self._data)
992        if self._minmaxy is not None:
993            self._plotter.set_limits(ylim=self._minmaxy)
994        if self.casabar_exists(): self._plotter.figmgr.casabar.enable_button()
995        self._plotter.release()
996        self._plotter.tidy()
997        self._plotter.show(hardrefresh=False)
998        return
999
[920]1000    def _plot(self, scan):
[947]1001        savesel = scan.get_selection()
1002        sel = savesel +  self._selection
[1910]1003        order = self._get_sortstring([self._panelling,self._stacking])
1004        if order:
1005            sel.set_order(order)
[947]1006        scan.set_selection(sel)
[920]1007        d = {'b': scan.getbeam, 's': scan.getscan,
[1949]1008             'i': scan.getif, 'p': scan.getpol, 't': scan.get_time,
[1989]1009             'r': int}#, '_r': int}
[920]1010
[2650]1011        polmodes = dict(zip(sel.get_pols(), sel.get_poltypes()))
[1148]1012        # this returns either a tuple of numbers or a length  (ncycles)
1013        # convert this into lengths
1014        n0,nstack0 = self._get_selected_n(scan)
1015        if isinstance(n0, int): n = n0
[1175]1016        else: n = len(n0)
[1148]1017        if isinstance(nstack0, int): nstack = nstack0
[1175]1018        else: nstack = len(nstack0)
[1989]1019        # In case of row stacking
1020        rowstack = False
1021        titlemode = self._panelling
1022        if self._stacking == "r" and self._panelling != "r":
1023            rowstack = True
1024            titlemode = '_r'
[1913]1025        nptot = n
[1582]1026        maxpanel, maxstack = 16,16
[1913]1027        if nstack > maxstack:
1028            msg ="Scan to be overlayed contains more than %d selections.\n" \
1029                  "Selecting first %d selections..." % (maxstack, maxstack)
[920]1030            asaplog.push(msg)
[1861]1031            asaplog.post('WARN')
[998]1032            nstack = min(nstack,maxstack)
[2038]1033        #n = min(n-self._ipanel-1,maxpanel)
1034        n = n-self._ipanel-1
[2697]1035        # the number of panels in this page
1036        if self._rows and self._cols:
1037            n = min(n,self._rows*self._cols)
1038        else:
1039            n = min(n,maxpanel)
[2011]1040
[2697]1041        firstpage = (self._ipanel < 0)
1042        #ganged = False
1043        ganged = rcParams['plotter.ganged']
1044        if self._panelling == 'i':
1045            ganged = False
[2715]1046        if (not firstpage) and \
1047               self._plotter._subplotsOk(self._rows, self._cols, n):
1048            # Not the first page and subplot number is ok.
1049            # Just clear the axis
[2697]1050            nx = self._plotter.cols
1051            ipaxx = n - nx - 1 #the max panel id to supress x-label
1052            for ip in xrange(len(self._plotter.subplots)):
1053                self._plotter.subplot(ip)
1054                self._plotter.clear()
1055                self._plotter.axes.set_visible((ip<n))
1056                if ganged:
1057                    self._plotter.axes.xaxis.label.set_visible((ip > ipaxx))
1058                    if ip <= ipaxx:
1059                        map(lambda x: x.set_visible(False), \
1060                            self._plotter.axes.get_xticklabels())
1061                    self._plotter.axes.yaxis.label.set_visible((ip % nx)==0)
1062                    if ip % nx:
1063                        map(lambda y: y.set_visible(False), \
1064                            self._plotter.axes.get_yticklabels())
1065        elif (n > 1 and self._rows and self._cols):
[920]1066                self._plotter.set_panels(rows=self._rows,cols=self._cols,
[2650]1067                                         nplots=n,margin=self._margins,
1068                                         ganged=ganged)
[920]1069        else:
[2697]1070            self._plotter.set_panels(rows=n,cols=0,nplots=n,
1071                                     margin=self._margins,ganged=ganged)
[1913]1072        #r = 0
[1981]1073        r = self._startrow
[920]1074        nr = scan.nrow()
1075        a0,b0 = -1,-1
1076        allxlim = []
[1018]1077        allylim = []
[1981]1078        #newpanel=True
1079        newpanel=False
[920]1080        panelcount,stackcount = 0,0
[1981]1081        # If this is not the first page
1082        if r > 0:
1083            # panelling value of the prev page
1084            a0 = d[self._panelling](r-1)
1085            # set the initial stackcount large not to plot
1086            # the start row automatically
1087            stackcount = nstack
1088
[1002]1089        while r < nr:
[920]1090            a = d[self._panelling](r)
1091            b = d[self._stacking](r)
1092            if a > a0 and panelcount < n:
1093                if n > 1:
1094                    self._plotter.subplot(panelcount)
1095                self._plotter.palette(0)
1096                #title
1097                xlab = self._abcissa and self._abcissa[panelcount] \
1098                       or scan._getabcissalabel()
[1897]1099                if self._offset and not self._abcissa:
1100                    xlab += " (relative)"
[920]1101                ylab = self._ordinate and self._ordinate[panelcount] \
1102                       or scan._get_ordinate_label()
[1547]1103                self._plotter.set_axes('xlabel', xlab)
1104                self._plotter.set_axes('ylabel', ylab)
[1989]1105                #lbl = self._get_label(scan, r, self._panelling, self._title)
1106                lbl = self._get_label(scan, r, titlemode, self._title)
[920]1107                if isinstance(lbl, list) or isinstance(lbl, tuple):
1108                    if 0 <= panelcount < len(lbl):
1109                        lbl = lbl[panelcount]
1110                    else:
1111                        # get default label
[1989]1112                        #lbl = self._get_label(scan, r, self._panelling, None)
1113                        lbl = self._get_label(scan, r, titlemode, None)
[920]1114                self._plotter.set_axes('title',lbl)
1115                newpanel = True
[1913]1116                stackcount = 0
[920]1117                panelcount += 1
[1981]1118                # save the start row to plot this panel for future revisit.
1119                if self._panelling != 'r' and \
1120                       len(self._panelrows) < self._ipanel+1+panelcount:
1121                    self._panelrows += [r]
1122                   
[1944]1123            #if (b > b0 or newpanel) and stackcount < nstack:
[2650]1124            if stackcount < nstack and (newpanel or \
1125                                            rowstack or (a == a0 and b > b0)):
[920]1126                y = []
1127                if len(polmodes):
1128                    y = scan._getspectrum(r, polmodes[scan.getpol(r)])
1129                else:
1130                    y = scan._getspectrum(r)
[1995]1131                # flag application
1132                mr = scan._getflagrow(r)
[1739]1133                from numpy import ma, array
[1995]1134                if mr:
1135                    y = ma.masked_array(y,mask=mr)
1136                else:
1137                    m = scan._getmask(r)
1138                    from numpy import logical_not, logical_and
1139                    if self._maskselection and len(self._usermask) == len(m):
[2277]1140                        if d[self._stacking](r) in self._maskselection[self._stacking]:
[1995]1141                            m = logical_and(m, self._usermask)
[2277]1142                    y = ma.masked_array(y,mask=logical_not(array(m,copy=False)))
[1995]1143
[1897]1144                x = array(scan._getabcissa(r))
1145                if self._offset:
1146                    x += self._offset
[920]1147                if self._minmaxx is not None:
1148                    s,e = self._slice_indeces(x)
1149                    x = x[s:e]
1150                    y = y[s:e]
[1096]1151                if len(x) > 1024 and rcParams['plotter.decimate']:
1152                    fac = len(x)/1024
[920]1153                    x = x[::fac]
1154                    y = y[::fac]
1155                llbl = self._get_label(scan, r, self._stacking, self._lmap)
1156                if isinstance(llbl, list) or isinstance(llbl, tuple):
1157                    if 0 <= stackcount < len(llbl):
1158                        # use user label
1159                        llbl = llbl[stackcount]
1160                    else:
1161                        # get default label
1162                        llbl = self._get_label(scan, r, self._stacking, None)
1163                self._plotter.set_line(label=llbl)
[1023]1164                plotit = self._plotter.plot
1165                if self._hist: plotit = self._plotter.hist
[1995]1166                if len(x) > 0 and not mr:
[1146]1167                    plotit(x,y)
1168                    xlim= self._minmaxx or [min(x),max(x)]
1169                    allxlim += xlim
1170                    ylim= self._minmaxy or [ma.minimum(y),ma.maximum(y)]
1171                    allylim += ylim
[1819]1172                else:
1173                    xlim = self._minmaxx or []
1174                    allxlim += xlim
1175                    ylim= self._minmaxy or []
1176                    allylim += ylim
[920]1177                stackcount += 1
[1981]1178                a0=a
1179                b0=b
[920]1180                # last in colour stack -> autoscale x
[1819]1181                if stackcount == nstack and len(allxlim) > 0:
[920]1182                    allxlim.sort()
[1819]1183                    self._plotter.subplots[panelcount-1]['axes'].set_xlim([allxlim[0],allxlim[-1]])
[1989]1184                    if ganged:
1185                        allxlim = [allxlim[0],allxlim[-1]]
1186                    else:
1187                        # clear
1188                        allxlim =[]
[920]1189
1190            newpanel = False
[1981]1191            #a0=a
1192            #b0=b
[920]1193            # ignore following rows
[1981]1194            if (panelcount == n and stackcount == nstack) or (r == nr-1):
[1018]1195                # last panel -> autoscale y if ganged
[1989]1196                #if rcParams['plotter.ganged'] and len(allylim) > 0:
1197                if ganged and len(allylim) > 0:
[1018]1198                    allylim.sort()
1199                    self._plotter.set_limits(ylim=[allylim[0],allylim[-1]])
[998]1200                break
[920]1201            r+=1 # next row
[1981]1202
1203        # save the current counter for multi-page plotting
1204        self._startrow = r+1
1205        self._ipanel += panelcount
[2147]1206        if self.casabar_exists():
[1981]1207            if self._ipanel >= nptot-1:
[1913]1208                self._plotter.figmgr.casabar.disable_next()
1209            else:
1210                self._plotter.figmgr.casabar.enable_next()
[1981]1211            if self._ipanel + 1 - panelcount > 0:
1212                self._plotter.figmgr.casabar.enable_prev()
1213            else:
1214                self._plotter.figmgr.casabar.disable_prev()
1215
[947]1216        #reset the selector to the scantable's original
1217        scan.set_selection(savesel)
[1824]1218
[1819]1219        #temporary switch-off for older matplotlib
1220        #if self._fp is not None:
[2698]1221        if self._fp is not None and \
1222               getattr(self._plotter.figure,'findobj',False):
[1556]1223            for o in self._plotter.figure.findobj(Text):
[2697]1224                if not self._headtext['textobj'] or \
1225                   not (o in self._headtext['textobj']):
1226                    o.set_fontproperties(self._fp)
[920]1227
[1910]1228    def _get_sortstring(self, lorders):
1229        d0 = {'s': 'SCANNO', 'b': 'BEAMNO', 'i':'IFNO',
1230              'p': 'POLNO', 'c': 'CYCLENO', 't' : 'TIME', 'r':None, '_r':None }
[1944]1231        if not (type(lorders) == list) and not (type(lorders) == tuple):
[1910]1232            return None
1233        if len(lorders) > 0:
1234            lsorts = []
1235            for order in lorders:
[1989]1236                if order == "r":
1237                    # don't sort if row panelling/stacking
1238                    return None
[1910]1239                ssort = d0[order]
1240                if ssort:
1241                    lsorts.append(ssort)
1242            return lsorts
1243        return None
1244
[920]1245    def _get_selected_n(self, scan):
[1148]1246        d1 = {'b': scan.getbeamnos, 's': scan.getscannos,
[1910]1247             'i': scan.getifnos, 'p': scan.getpolnos, 't': scan.ncycle,
[1989]1248             'r': scan.nrow}#, '_r': False}
[1148]1249        d2 = { 'b': self._selection.get_beams(),
1250               's': self._selection.get_scans(),
1251               'i': self._selection.get_ifs(),
1252               'p': self._selection.get_pols(),
[1910]1253               't': self._selection.get_cycles(),
[1989]1254               'r': False}#, '_r': 1}
[920]1255        n =  d2[self._panelling] or d1[self._panelling]()
1256        nstack = d2[self._stacking] or d1[self._stacking]()
[1989]1257        # handle row panelling/stacking
1258        if self._panelling == 'r':
1259            nstack = 1
1260        elif self._stacking == 'r':
1261            n = 1
[920]1262        return n,nstack
1263
1264    def _get_label(self, scan, row, mode, userlabel=None):
[1153]1265        if isinstance(userlabel, list) and len(userlabel) == 0:
1266            userlabel = " "
[947]1267        pms = dict(zip(self._selection.get_pols(),self._selection.get_poltypes()))
[920]1268        if len(pms):
1269            poleval = scan._getpollabel(scan.getpol(row),pms[scan.getpol(row)])
1270        else:
1271            poleval = scan._getpollabel(scan.getpol(row),scan.poltype())
1272        d = {'b': "Beam "+str(scan.getbeam(row)),
[1819]1273             #'s': scan._getsourcename(row),
1274             's': "Scan "+str(scan.getscan(row))+\
1275                  " ("+str(scan._getsourcename(row))+")",
[920]1276             'i': "IF"+str(scan.getif(row)),
[964]1277             'p': poleval,
[1910]1278             't': str(scan.get_time(row)),
1279             'r': "row "+str(row),
[1913]1280             #'_r': str(scan.get_time(row))+",\nIF"+str(scan.getif(row))+", "+poleval+", Beam"+str(scan.getbeam(row)) }
1281             '_r': "" }
[920]1282        return userlabel or d[mode]
[1153]1283
[2700]1284    def _slice_indeces(self, data):
1285        mn = self._minmaxx[0]
1286        mx = self._minmaxx[1]
1287        asc = data[0] < data[-1]
1288        start=0
1289        end = len(data)-1
1290        inc = 1
1291        if not asc:
1292            start = len(data)-1
1293            end = 0
1294            inc = -1
1295        # find min index
1296        #while start > 0 and data[start] < mn:
1297        #    start+= inc
1298        minind=start
1299        for ind in xrange(start,end+inc,inc):
1300            if data[ind] > mn: break
1301            minind=ind
1302        # find max index
1303        #while end > 0 and data[end] > mx:
1304        #    end-=inc
1305        #if end > 0: end +=1
1306        maxind=end
1307        for ind in xrange(end,start-inc,-inc):
1308            if data[ind] < mx: break
1309            maxind=ind
1310        start=minind
1311        end=maxind
1312        if start > end:
1313            return end,start+1
1314        elif start < end:
1315            return start,end+1
1316        else:
1317            return start,end
1318
[1819]1319    def plotazel(self, scan=None, outfile=None):
[1391]1320        """
[1696]1321        plot azimuth and elevation versus time of a scantable
[1391]1322        """
[2704]1323        self._plotmode = "azel"
[1923]1324        visible = rcParams['plotter.gui']
[1696]1325        from matplotlib import pylab as PL
[2586]1326        from matplotlib.dates import DateFormatter
1327        from pytz import timezone
[1696]1328        from matplotlib.dates import HourLocator, MinuteLocator,SecondLocator, DayLocator
[1391]1329        from matplotlib.ticker import MultipleLocator
[2953]1330        from numpy import array, pi, ma
[2704]1331        if self._plotter and (PL.gcf() == self._plotter.figure):
[2699]1332            # the current figure is ASAP plotter. Use mpl plotter
1333            figids = PL.get_fignums()
[2704]1334            PL.figure(max(figids[-1],1))
1335
[1923]1336        if not visible or not self._visible:
1337            PL.ioff()
1338            from matplotlib.backends.backend_agg import FigureCanvasAgg
1339            PL.gcf().canvas.switch_backends(FigureCanvasAgg)
[1819]1340        self._data = scan
[1556]1341        dates = self._data.get_time(asdatetime=True)
[2953]1342        # for flag handling
1343        mask = [ self._data._is_all_chan_flagged(i) for i in range(self._data.nrow())]
[1391]1344        t = PL.date2num(dates)
1345        tz = timezone('UTC')
1346        PL.cla()
1347        PL.ioff()
1348        PL.clf()
[2037]1349        # Adjust subplot margins
[2576]1350        if not self._margins or len(self._margins) != 6:
[2037]1351            self.set_margin(refresh=False)
1352        lef, bot, rig, top, wsp, hsp = self._margins
[1819]1353        PL.gcf().subplots_adjust(left=lef,bottom=bot,right=rig,top=top,
1354                                 wspace=wsp,hspace=hsp)
[1824]1355
[1391]1356        tdel = max(t) - min(t)
1357        ax = PL.subplot(2,1,1)
[2953]1358        el = ma.masked_array(array(self._data.get_elevation())*180./pi, mask)
[1391]1359        PL.ylabel('El [deg.]')
1360        dstr = dates[0].strftime('%Y/%m/%d')
1361        if tdel > 1.0:
1362            dstr2 = dates[len(dates)-1].strftime('%Y/%m/%d')
1363            dstr = dstr + " - " + dstr2
1364            majloc = DayLocator()
1365            minloc = HourLocator(range(0,23,12))
1366            timefmt = DateFormatter("%b%d")
[1696]1367        elif tdel > 24./60.:
1368            timefmt = DateFormatter('%H:%M')
1369            majloc = HourLocator()
1370            minloc = MinuteLocator(30)
[1391]1371        else:
[1696]1372            timefmt = DateFormatter('%H:%M')
1373            majloc = MinuteLocator(interval=5)
1374            minloc = SecondLocator(30)
1375
[1391]1376        PL.title(dstr)
[1819]1377        if tdel == 0.0:
1378            th = (t - PL.floor(t))*24.0
1379            PL.plot(th,el,'o',markersize=2, markerfacecolor='b', markeredgecolor='b')
1380        else:
1381            PL.plot_date(t,el,'o', markersize=2, markerfacecolor='b', markeredgecolor='b',tz=tz)
1382            #ax.grid(True)
1383            ax.xaxis.set_major_formatter(timefmt)
1384            ax.xaxis.set_major_locator(majloc)
1385            ax.xaxis.set_minor_locator(minloc)
[1391]1386        ax.yaxis.grid(True)
[1819]1387        yloc = MultipleLocator(30)
1388        ax.set_ylim(0,90)
1389        ax.yaxis.set_major_locator(yloc)
[1391]1390        if tdel > 1.0:
1391            labels = ax.get_xticklabels()
1392        #    PL.setp(labels, fontsize=10, rotation=45)
1393            PL.setp(labels, fontsize=10)
[1819]1394
[1391]1395        # Az plot
[2953]1396        az = ma.masked_array(array(self._data.get_azimuth())*180./pi, mask)
[1391]1397        if min(az) < 0:
1398            for irow in range(len(az)):
1399                if az[irow] < 0: az[irow] += 360.0
1400
[1819]1401        ax2 = PL.subplot(2,1,2)
1402        #PL.xlabel('Time (UT [hour])')
1403        PL.ylabel('Az [deg.]')
1404        if tdel == 0.0:
1405            PL.plot(th,az,'o',markersize=2, markeredgecolor='b',markerfacecolor='b')
1406        else:
1407            PL.plot_date(t,az,'o', markersize=2,markeredgecolor='b',markerfacecolor='b',tz=tz)
1408            ax2.xaxis.set_major_formatter(timefmt)
1409            ax2.xaxis.set_major_locator(majloc)
1410            ax2.xaxis.set_minor_locator(minloc)
1411        #ax2.grid(True)
1412        ax2.set_ylim(0,360)
[1696]1413        ax2.yaxis.grid(True)
[1819]1414        #hfmt = DateFormatter('%H')
1415        #hloc = HourLocator()
1416        yloc = MultipleLocator(60)
1417        ax2.yaxis.set_major_locator(yloc)
1418        if tdel > 1.0:
1419            labels = ax2.get_xticklabels()
1420            PL.setp(labels, fontsize=10)
1421            PL.xlabel('Time (UT [day])')
1422        else:
1423            PL.xlabel('Time (UT [hour])')
1424
[1391]1425        PL.ion()
1426        PL.draw()
[2416]1427        if matplotlib.get_backend() == 'Qt4Agg': PL.gcf().show()
[2576]1428        if (outfile is not None):
1429           PL.savefig(outfile)
[1391]1430
[2693]1431
1432    def plotpointing2(self, scan=None, colorby='', showline=False, projection=''):
1433        """
1434        plot telescope pointings
1435        Parameters:
1436            infile  : input filename or scantable instance
1437            colorby : change color by either
1438                      'type'(source type)|'scan'|'if'|'pol'|'beam'
1439            showline : show dotted line
1440            projection : projection type either
1441                         ''(no projection [deg])|'coord'(not implemented)
1442        """
[2704]1443        self._plotmode = "pointing"
[2953]1444        from numpy import array, pi, ma
[2693]1445        from asap import scantable
1446        # check for scantable
1447        if isinstance(scan, scantable):
1448            if self._data is not None:
1449                if scan != self._data:
1450                    self._data = scan
1451                    # reset
1452                    self._reset()
1453            else:
1454                self._data = scan
1455                self._reset()
1456        if not self._data:
1457            msg = "Input is not a scantable"
1458            raise TypeError(msg)
1459        # check for color mode
1460        validtypes=['type','scan','if','pol', 'beam']
1461        stype = None
1462        if (colorby in validtypes):
1463            stype = colorby[0]
1464        elif len(colorby) > 0:
1465            msg = "Invalid choice of 'colorby' (choices: %s)" % str(validtypes)
1466            raise ValueError(msg)
1467        self._assert_plotter(action="reload")
1468        self._plotter.hold()
[2697]1469        self._reset_counter()
[2694]1470        if self.casabar_exists():
1471            self._plotter.figmgr.casabar.disable_button()
[2693]1472        # for now, only one plot
1473        self._plotter.set_panels(rows=1,cols=1)
1474        # first panel
1475        self._plotter.subplot(0)
1476        # first color and linestyles
1477        self._plotter.palette(0)
1478        self.gca().set_aspect('equal')
1479        basesel = scan.get_selection()
[2694]1480        attrback = self._plotter.get_line()
1481        marker = "o"
[2693]1482        if showline:
1483            basesel.set_order(["TIME"])
1484            scan.set_selection(basesel)
1485            if not (stype in ["t", "s"]):
[2694]1486                marker += ":"
1487        self._plotter.set_line(markersize=3, markeredgewidth=0)
1488
[2693]1489        if not stype:
1490            selIds = [""] # cheating
1491            sellab = "all points"
1492        elif stype == 't':
1493            selIds = range(15)
1494            sellab = "src type "
1495        else:
1496            selIds = getattr(self._data,'get'+colorby+'nos')()
1497            sellab = colorby.upper()
1498        selFunc = "set_"+colorby+"s"
1499        for idx in selIds:
1500            sel = selector() + basesel
1501            if stype:
1502                bid = getattr(basesel,'get_'+colorby+"s")()
1503                if (len(bid) > 0) and (not idx in bid):
1504                    # base selection doesn't contain idx
1505                    # Note summation of selector is logical sum if
1506                    continue
1507                getattr(sel, selFunc)([idx])
1508            if not sel.is_empty():
1509                try:
1510                    self._data.set_selection(sel)
1511                except RuntimeError, instance:
1512                    if stype == 't' and str(instance).startswith("Selection contains no data."):
1513                        continue
1514                    else:
1515                        self._data.set_selection(basesel)
1516                        raise RuntimeError, instance
1517            if self._data.nrow() == 0:
1518                self._data.set_selection(basesel)
1519                continue
[2795]1520            #print "Plotting direction of %s = %s" % (colorby, str(idx))
[2694]1521            # getting data to plot
[2693]1522            dir = array(self._data.get_directionval()).transpose()
[2953]1523            # for flag handling
1524            mask = [ self._data._is_all_chan_flagged(i) for i in range(self._data.nrow())]
[2693]1525            ra = dir[0]*180./pi
[2953]1526            dec = ma.masked_array(dir[1]*180./pi, mask)
[2694]1527            # actual plot
[2693]1528            self._plotter.set_line(label=(sellab+str(idx)))
1529            self._plotter.plot(ra,dec,marker)
1530
1531        # restore original selection
1532        self._data.set_selection(basesel)
1533        # need to plot scan pattern explicitly
1534        if showline and (stype in ["t", "s"]):
1535            dir = array(self._data.get_directionval()).transpose()
1536            ra = dir[0]*180./pi
1537            dec = dir[1]*180./pi
1538            self._plotter.set_line(label="scan pattern")
1539            self._plotter.plot(ra,dec,":")
[2694]1540            # set color for only this line
1541            self._plotter.lines[-1][0].set_color("gray")
1542
[2693]1543        xlab = 'RA [deg.]'
1544        ylab = 'Declination [deg.]'
1545        self._plotter.set_axes('xlabel', xlab)
1546        self._plotter.set_axes('ylabel', ylab)
1547        self._plotter.set_axes('title', 'Telescope pointings')
1548        if stype: self._plotter.legend(self._legendloc)
1549        else: self._plotter.legend(None)
1550        # reverse x-axis
1551        xmin, xmax = self.gca().get_xlim()
1552        self._plotter.set_limits(xlim=[xmax,xmin])
1553
1554        self._plotter.release()
1555        self._plotter.show(hardrefresh=False)
[2694]1556        # reset line settings
1557        self._plotter.set_line(**attrback)
[2693]1558        return
1559
[1819]1560    def plotpointing(self, scan=None, outfile=None):
[1391]1561        """
1562        plot telescope pointings
1563        """
[1923]1564        visible = rcParams['plotter.gui']
[1696]1565        from matplotlib import pylab as PL
[1819]1566        from numpy import array, pi
[2704]1567        if self._plotter and (PL.gcf() == self._plotter.figure):
[2699]1568            # the current figure is ASAP plotter. Use mpl plotter
1569            figids = PL.get_fignums()
[2704]1570            PL.figure(max(figids[-1],1))
1571
[1923]1572        if not visible or not self._visible:
1573            PL.ioff()
1574            from matplotlib.backends.backend_agg import FigureCanvasAgg
1575            PL.gcf().canvas.switch_backends(FigureCanvasAgg)
[1819]1576        self._data = scan
[1391]1577        dir = array(self._data.get_directionval()).transpose()
1578        ra = dir[0]*180./pi
1579        dec = dir[1]*180./pi
1580        PL.cla()
[1819]1581        #PL.ioff()
[1391]1582        PL.clf()
[2037]1583        # Adjust subplot margins
[2576]1584        if not self._margins or len(self._margins) != 6:
[2037]1585            self.set_margin(refresh=False)
1586        lef, bot, rig, top, wsp, hsp = self._margins
[1819]1587        PL.gcf().subplots_adjust(left=lef,bottom=bot,right=rig,top=top,
1588                                 wspace=wsp,hspace=hsp)
1589        ax = PL.gca()
1590        #ax = PL.axes([0.1,0.1,0.8,0.8])
1591        #ax = PL.axes([0.1,0.1,0.8,0.8])
[1391]1592        ax.set_aspect('equal')
[1696]1593        PL.plot(ra, dec, 'b,')
[1391]1594        PL.xlabel('RA [deg.]')
1595        PL.ylabel('Declination [deg.]')
1596        PL.title('Telescope pointings')
1597        [xmin,xmax,ymin,ymax] = PL.axis()
1598        PL.axis([xmax,xmin,ymin,ymax])
[2416]1599        PL.ion()
[1391]1600        PL.draw()
[2416]1601        if matplotlib.get_backend() == 'Qt4Agg': PL.gcf().show()
[2576]1602        if (outfile is not None):
1603           PL.savefig(outfile)
[1819]1604
1605    # plot total power data
1606    # plotting in time is not yet implemented..
[1862]1607    @asaplog_post_dec
[2576]1608    def plottp(self, scan=None):
[2704]1609        self._plotmode = "totalpower"
[1819]1610        from asap import scantable
1611        if not self._data and not scan:
1612            msg = "Input is not a scantable"
1613            raise TypeError(msg)
1614        if isinstance(scan, scantable):
1615            if self._data is not None:
1616                if scan != self._data:
1617                    self._data = scan
1618                    # reset
1619                    self._reset()
1620            else:
1621                self._data = scan
1622                self._reset()
1623        # ranges become invalid when abcissa changes?
1624        #if self._abcunit and self._abcunit != self._data.get_unit():
1625        #    self._minmaxx = None
1626        #    self._minmaxy = None
1627        #    self._abcunit = self._data.get_unit()
1628
[2693]1629        self._assert_plotter(action="reload")
1630        self._plotter.hold()
1631        self._plotter.clear()
[2037]1632        # Adjust subplot margins
[2576]1633        if not self._margins or len(self._margins) !=6:
1634            self.set_margin(refresh=False)
[2037]1635        lef, bot, rig, top, wsp, hsp = self._margins
[1819]1636        self._plotter.figure.subplots_adjust(
1637            left=lef,bottom=bot,right=rig,top=top,wspace=wsp,hspace=hsp)
[2147]1638        if self.casabar_exists(): self._plotter.figmgr.casabar.disable_button()
[1819]1639        self._plottp(self._data)
1640        if self._minmaxy is not None:
1641            self._plotter.set_limits(ylim=self._minmaxy)
1642        self._plotter.release()
1643        self._plotter.tidy()
1644        self._plotter.show(hardrefresh=False)
1645        return
1646
1647    def _plottp(self,scan):
1648        """
1649        private method for plotting total power data
1650        """
1651        from numpy import ma, array, arange, logical_not
1652        r=0
1653        nr = scan.nrow()
1654        a0,b0 = -1,-1
1655        allxlim = []
1656        allylim = []
1657        y=[]
1658        self._plotter.set_panels()
1659        self._plotter.palette(0)
1660        #title
1661        #xlab = self._abcissa and self._abcissa[panelcount] \
1662        #       or scan._getabcissalabel()
1663        #ylab = self._ordinate and self._ordinate[panelcount] \
1664        #       or scan._get_ordinate_label()
1665        xlab = self._abcissa or 'row number' #or Time
1666        ylab = self._ordinate or scan._get_ordinate_label()
1667        self._plotter.set_axes('xlabel',xlab)
1668        self._plotter.set_axes('ylabel',ylab)
1669        lbl = self._get_label(scan, r, 's', self._title)
1670        if isinstance(lbl, list) or isinstance(lbl, tuple):
1671        #    if 0 <= panelcount < len(lbl):
1672        #        lbl = lbl[panelcount]
1673        #    else:
1674                # get default label
1675             lbl = self._get_label(scan, r, self._panelling, None)
1676        self._plotter.set_axes('title',lbl)
1677        y=array(scan._get_column(scan._getspectrum,-1))
1678        m = array(scan._get_column(scan._getmask,-1))
1679        y = ma.masked_array(y,mask=logical_not(array(m,copy=False)))
1680        x = arange(len(y))
1681        # try to handle spectral data somewhat...
1682        l,m = y.shape
1683        if m > 1:
1684            y=y.mean(axis=1)
[2953]1685        # flag handling
1686        m = [ scan._is_all_chan_flagged(i) for i in range(scan.nrow()) ]
1687        y = ma.masked_array(y,mask=m)
[1819]1688        plotit = self._plotter.plot
1689        llbl = self._get_label(scan, r, self._stacking, None)
1690        self._plotter.set_line(label=llbl)
1691        if len(x) > 0:
1692            plotit(x,y)
1693
1694
1695    # printing header information
[1862]1696    @asaplog_post_dec
[2053]1697    def print_header(self, plot=True, fontsize=9, logger=False, selstr='', extrastr=''):
[1819]1698        """
1699        print data (scantable) header on the plot and/or logger.
[2056]1700        To plot the header on the plot, this method should be called after
1701        plotting spectra by the method, asapplotter.plot.
[1819]1702        Parameters:
[1824]1703            plot:      whether or not print header info on the plot.
[2053]1704            fontsize:  header font size (valid only plot=True)
[1819]1705            logger:    whether or not print header info on the logger.
1706            selstr:    additional selection string (not verified)
[2053]1707            extrastr:  additional string to print at the beginning (not verified)
[1819]1708        """
[1859]1709        if not plot and not logger:
1710            return
1711        if not self._data:
1712            raise RuntimeError("No scantable has been set yet.")
[1824]1713        # Now header will be printed on plot and/or logger.
1714        # Get header information and format it.
[2112]1715        ssum=self._data._list_header()
[1819]1716        # Print Observation header to the upper-left corner of plot
[2290]1717        headstr=[ssum[0:ssum.find('Obs. Type:')]]
1718        headstr.append(ssum[ssum.find('Obs. Type:'):ssum.find('Flux Unit:')])
[2053]1719        if extrastr != '':
1720            headstr[0]=extrastr+'\n'+headstr[0]
1721            self._headtext['extrastr'] = extrastr
[2112]1722        if selstr != '':
1723            selstr += '\n'
1724            self._headtext['selstr'] = selstr
[2944]1725        #ssel=(selstr+self._data.get_selection().__str__()+self._selection.__str__() or 'none')
[2945]1726        curr_selstr = selstr+self._data.get_selection().__str__() or "none"
1727        ssel=(curr_selstr+"\n" +self._selection.__str__())
[2927]1728        headstr.append('\n\n***Selections***\n'+ssel.replace('$','\$'))
[1824]1729
[2051]1730        if plot:
[2451]1731            errmsg = "Can plot header only after the first call to plot()."
[2453]1732            self._assert_plotter(action="halt",errmsg=errmsg)
[1819]1733            self._plotter.hold()
[2053]1734            self._header_plot(headstr,fontsize=fontsize)
[2697]1735            #import time
1736            #self._plotter.figure.text(0.99,0.01,
1737            #                time.strftime("%a %d %b %Y  %H:%M:%S %Z"),
1738            #                horizontalalignment='right',
1739            #                verticalalignment='bottom',fontsize=8)
[1819]1740            self._plotter.release()
1741        if logger:
[2053]1742            selstr = "Selections:    "+ssel
[1819]1743            asaplog.push("----------------\n  Plot Summary\n----------------")
[2053]1744            asaplog.push(extrastr)
[2290]1745            asaplog.push(ssum[0:ssum.find('Selection:')]\
[2112]1746                         + selstr)
[2053]1747        self._headtext['string'] = headstr
1748        del ssel, ssum, headstr
[2051]1749
[2053]1750    def _header_plot(self, texts, fontsize=9):
1751        self._headtext['textobj']=[]
1752        nstcol=len(texts)
1753        for i in range(nstcol):
1754            self._headtext['textobj'].append(
1755                self._plotter.figure.text(0.03+float(i)/nstcol,0.98,
1756                                          texts[i],
1757                                          horizontalalignment='left',
1758                                          verticalalignment='top',
1759                                          fontsize=fontsize))
1760
1761    def clear_header(self):
1762        if not self._headtext['textobj']:
1763            asaplog.push("No header has been plotted. Exit without any operation")
1764            asaplog.post("WARN")
[2453]1765        elif self._assert_plotter(action="status"):
[2053]1766            self._plotter.hold()
1767            for textobj in self._headtext['textobj']:
1768                #if textobj.get_text() in self._headstring:
1769                try:
1770                    textobj.remove()
1771                except NotImplementedError:
1772                    self._plotter.figure.texts.pop(self._plotter.figure.texts.index(textobj))
1773            self._plotter.release()
1774        self._reset_header()
[2576]1775
1776    # plot spectra by pointing
1777    @asaplog_post_dec
[2717]1778    def plotgrid(self, scan=None,center="",spacing=[],rows=None,cols=None):
[2576]1779        """
1780        Plot spectra based on direction.
1781       
1782        Parameters:
1783            scan:      a scantable to plot
[2717]1784            center:    the grid center direction (a string)
[2576]1785                       (default) the center of map region
[2717]1786                       (example) 'J2000 19h30m00s -25d00m00s'
[2576]1787            spacing:   a list of horizontal (R.A.) and vertical (Dec.)
[2717]1788                       spacing.
[2576]1789                       (default) Calculated by the extent of map region and
[2717]1790                       (example) ['1arcmin', '1arcmin']
[2576]1791                       the number of rows and cols to cover
1792            rows:      number of panels (grid points) in horizontal direction
1793            cols:      number of panels (grid points) in vertical direction
1794
1795        Note:
1796        - Only the first IFNO, POLNO, and BEAM in the scantable will be
1797        plotted.
1798        - This method doesn't re-grid and average spectra in scantable. Use
1799        asapgrid module to re-grid spectra before plotting with this method.
1800        Only the first spectrum is plotted in case there are multiple
1801        spectra which belong to a grid.
1802        """
[2704]1803        self._plotmode = "grid"
[2576]1804        from asap import scantable
[2607]1805        from numpy import array, ma, cos
[2576]1806        if not self._data and not scan:
1807            msg = "No scantable is specified to plot"
1808            raise TypeError(msg)
[2604]1809        if scan:
1810            self.set_data(scan, refresh=False)
1811            del scan
1812
[2576]1813        # Rows and cols
[2717]1814        if (self._rows is None):
1815            rows = max(1, rows)
1816        if (self._cols is None):
1817            cols = max(1, cols)
1818        self.set_layout(rows,cols,False)
[2576]1819
[2717]1820        # Select the first IF, POL, and BEAM for plotting
[2576]1821        ntotpl = self._rows * self._cols
1822        ifs = self._data.getifnos()
1823        if len(ifs) > 1:
1824            msg = "Found multiple IFs in scantable. Only the first IF (IFNO=%d) will be plotted." % ifs[0]
1825            asaplog.post()
1826            asaplog.push(msg)
1827            asaplog.post("WARN")
1828        pols = self._data.getpolnos()
1829        if len(pols) > 1:
1830            msg = "Found multiple POLs in scantable. Only the first POL (POLNO=%d) will be plotted." % pols[0]
1831            asaplog.post()
1832            asaplog.push(msg)
1833            asaplog.post("WARN")
1834        beams = self._data.getbeamnos()
1835        if len(beams) > 1:
1836            msg = "Found multiple BEAMs in scantable. Only the first BEAM (BEAMNO=%d) will be plotted." % beams[0]
1837            asaplog.post()
1838            asaplog.push(msg)
1839            asaplog.post("WARN")
1840        self._data.set_selection(ifs=[ifs[0]],pols=[pols[0]],beams=[beams[0]])
1841        if self._data.nrow() > ntotpl:
1842            msg = "Scantable is finely sampled than plotting grids. "\
1843                  + "Only the first spectrum is plotted in each grid."
1844            asaplog.post()
1845            asaplog.push(msg)
1846            asaplog.post("WARN")
[2717]1847
1848        # Prepare plotter
[2576]1849        self._assert_plotter(action="reload")
1850        self._plotter.hold()
[2697]1851        self._reset_counter()
[2604]1852        self._plotter.legend()
[2691]1853
[2576]1854        # Adjust subplot margins
1855        if not self._margins or len(self._margins) !=6:
1856            self.set_margin(refresh=False)
1857        self._plotter.set_panels(rows=self._rows,cols=self._cols,
[2693]1858                                 nplots=ntotpl,margin=self._margins,ganged=True)       
[2603]1859        if self.casabar_exists():
1860            self._plotter.figmgr.casabar.enable_button()
[2691]1861        # Plot helper
1862        from asap._asap import plothelper as plhelper
1863        ph = plhelper(self._data)
[2717]1864        #ph.set_gridval(self._cols, self._rows, spacing[0], spacing[1],
1865        #                  center[0], center[1], epoch="J2000", projname="SIN")
1866        if type(spacing) in (list, tuple, array):
1867            if len(spacing) == 0:
1868                spacing = ["", ""]
1869            elif len(spacing) == 1:
1870                spacing = [spacing[0], spacing[0]]
1871        else:
1872            spacing = [spacing, spacing]
1873        ph.set_grid(self._cols, self._rows, spacing[0], spacing[1], \
1874                    center, projname="SIN")
1875
[2576]1876        # Actual plot
1877        npl = 0
1878        for irow in range(self._data.nrow()):
[2691]1879            (ix, iy) = ph.get_gpos(irow)
1880            #print("asapplotter.plotgrid: (ix, iy) = (%f, %f)" % (ix, iy))
[2576]1881            if ix < 0 or ix >= self._cols:
[2602]1882                #print "Row %d : Out of X-range (x = %f) ... skipped" % (irow, pos[0])
[2576]1883                continue
[2691]1884            ix = int(ix)
1885            if iy < 0 or iy >= self._rows:
[2602]1886                #print "Row %d : Out of Y-range (y = %f) ... skipped" % (irow,pos[1])
[2576]1887                continue
[2691]1888            iy = int(iy)
1889            ipanel = ix + iy*self._rows
1890            #print("Resolved panel Id (%d, %d): %d" % (ix, iy, ipanel))
[2576]1891            if len(self._plotter.subplots[ipanel]['lines']) > 0:
[2602]1892                #print "Row %d : panel %d lready plotted ... skipped" % (irow,ipanel)
[2576]1893                # a spectrum already plotted in the panel
1894                continue
1895            # Plotting this row
[2602]1896            #print "PLOTTING row %d (panel=%d)" % (irow, ipanel)
[2576]1897            npl += 1
1898            self._plotter.subplot(ipanel)
[2602]1899            self._plotter.palette(0,colormap=self._colormap, \
1900                                  linestyle=0,linestyles=self._linestyles)
[2576]1901            xlab = self._abcissa and self._abcissa[ipanel] \
[2603]1902                   or self._data._getabcissalabel(irow)
[2576]1903            if self._offset and not self._abcissa:
1904                xlab += " (relative)"
1905            ylab = self._ordinate and self._ordinate[ipanel] \
[2603]1906                   or self._data._get_ordinate_label()
[2576]1907            self._plotter.set_axes('xlabel', xlab)
1908            self._plotter.set_axes('ylabel', ylab)
1909            lbl = self._data.get_direction(irow)
1910            self._plotter.set_axes('title',lbl)
1911
[2603]1912            y = self._data._getspectrum(irow)
[2576]1913            # flag application
[2603]1914            mr = self._data._getflagrow(irow)
[2576]1915            if mr:  # FLAGROW=True
1916                y = ma.masked_array(y,mask=mr)
1917            else:
[2603]1918                m = self._data._getmask(irow)
[2576]1919                from numpy import logical_not, logical_and
1920                ### user mask is not available so far
1921                #if self._maskselection and len(self._usermask) == len(m):
1922                #    if d[self._stacking](irow) in self._maskselection[self._stacking]:
1923                #            m = logical_and(m, self._usermask)
1924                y = ma.masked_array(y,mask=logical_not(array(m,copy=False)))
1925
[2603]1926            x = array(self._data._getabcissa(irow))
[2576]1927            if self._offset:
1928                x += self._offset
1929            if self._minmaxx is not None:
1930                s,e = self._slice_indeces(x)
1931                x = x[s:e]
1932                y = y[s:e]
1933            if len(x) > 1024 and rcParams['plotter.decimate']:
1934                fac = len(x)/1024
1935                x = x[::fac]
1936                y = y[::fac]
1937            self._plotter.set_line(label=lbl)
1938            plotit = self._plotter.plot
1939            if self._hist: plotit = self._plotter.hist
1940            if len(x) > 0 and not mr:
1941                plotit(x,y)
1942#                 xlim= self._minmaxx or [min(x),max(x)]
1943#                 allxlim += xlim
1944#                 ylim= self._minmaxy or [ma.minimum(y),ma.maximum(y)]
1945#                 allylim += ylim
1946#             else:
1947#                 xlim = self._minmaxx or []
1948#                 allxlim += xlim
1949#                 ylim= self._minmaxy or []
1950#                 allylim += ylim
1951           
1952            if npl >= ntotpl:
1953                break
1954           
1955        if self._minmaxy is not None:
1956            self._plotter.set_limits(ylim=self._minmaxy)
1957        self._plotter.release()
1958        self._plotter.tidy()
1959        self._plotter.show(hardrefresh=False)
1960        return
Note: See TracBrowser for help on using the repository browser.