source: branches/casa-prerelease/pre-asap/python/asaplotbase.py @ 2069

Last change on this file since 2069 was 2069, checked in by Kana Sugimoto, 13 years ago

merged a bug fix in trunk (r2068)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 29.0 KB
RevLine 
[705]1"""
2ASAP plotting class based on matplotlib.
3"""
4
5import sys
6from re import match
7import matplotlib
8
9from matplotlib.figure import Figure, Text
[1147]10from matplotlib.font_manager import FontProperties as FP
[1739]11from numpy import sqrt
[705]12from matplotlib import rc, rcParams
[1259]13from matplotlib.ticker import OldScalarFormatter
[1147]14
[1826]15from asap.parameters import rcParams as asaprcParams
[1861]16from asap.logging import asaplog
[1826]17
[1425]18# API change in mpl >= 0.98
19try:
20    from matplotlib.transforms import blended_transform_factory
21except ImportError:
[1560]22    from matplotlib.transforms import blend_xy_sep_transform as blended_transform_factory
[1425]23
[1826]24if int(matplotlib.__version__.split(".")[1]) < 99:
[1819]25    #print "Warning: matplotlib version < 0.87. This might cause errors. Please upgrade."
[1826]26    asaplog.push( "matplotlib version < 0.99. This might cause errors. Please upgrade." )
[1861]27    asaplog.post( 'WARN' )
[1019]28
[705]29class asaplotbase:
30    """
31    ASAP plotting base class based on matplotlib.
32    """
33
[1563]34    def __init__(self, rows=1, cols=0, title='', size=None, buffering=False):
[1019]35        """
36        Create a new instance of the ASAPlot plotting class.
[705]37
[1019]38        If rows < 1 then a separate call to set_panels() is required to define
39        the panel layout; refer to the doctext for set_panels().
40        """
[705]41        self.is_dead = False
[1019]42        self.figure = Figure(figsize=size, facecolor='#ddddee')
[705]43        self.canvas = None
44
[1019]45        self.set_title(title)
46        self.subplots = []
47        if rows > 0:
48            self.set_panels(rows, cols)
[705]49
[710]50        # Set matplotlib default colour sequence.
51        self.colormap = "green red black cyan magenta orange blue purple yellow pink".split()
[1019]52
[710]53        c = asaprcParams['plotter.colours']
54        if isinstance(c,str) and len(c) > 0:
55            self.colormap = c.split()
56
57        self.lsalias = {"line":  [1,0],
58                        "dashdot": [4,2,1,2],
59                        "dashed" : [4,2,4,2],
60                        "dotted" : [1,2],
61                        "dashdotdot": [4,2,1,2,1,2],
62                        "dashdashdot": [4,2,4,2,1,2]
63                        }
64
65        styles = "line dashed dotted dashdot".split()
66        c = asaprcParams['plotter.linestyles']
67        if isinstance(c,str) and len(c) > 0:
68            styles = c.split()
69        s = []
70        for ls in styles:
71            if self.lsalias.has_key(ls):
72                s.append(self.lsalias.get(ls))
73            else:
74                s.append('-')
75        self.linestyles = s
76
[705]77        self.color = 0;
[710]78        self.linestyle = 0;
[1019]79        self.attributes = {}
80        self.loc = 0
[705]81
[1019]82        self.buffering = buffering
[705]83
84    def clear(self):
[1019]85        """
[1147]86        Delete all lines from the plot.  Line numbering will restart from 0.
[1019]87        """
[705]88
[1019]89        for i in range(len(self.lines)):
90           self.delete(i)
91        self.axes.clear()
92        self.color = 0
93        self.lines = []
[705]94
[710]95    def palette(self, color, colormap=None, linestyle=0, linestyles=None):
[705]96        if colormap:
[710]97            if isinstance(colormap,list):
98                self.colormap = colormap
99            elif isinstance(colormap,str):
100                self.colormap = colormap.split()
[705]101        if 0 <= color < len(self.colormap):
102            self.color = color
[710]103        if linestyles:
104            self.linestyles = []
105            if isinstance(linestyles,list):
106                styles = linestyles
107            elif isinstance(linestyles,str):
108                styles = linestyles.split()
109            for ls in styles:
110                if self.lsalias.has_key(ls):
111                    self.linestyles.append(self.lsalias.get(ls))
112                else:
113                    self.linestyles.append(self.lsalias.get('line'))
114        if 0 <= linestyle < len(self.linestyles):
115            self.linestyle = linestyle
[705]116
117    def delete(self, numbers=None):
[1019]118        """
119        Delete the 0-relative line number, default is to delete the last.
120        The remaining lines are NOT renumbered.
121        """
[705]122
[1019]123        if numbers is None: numbers = [len(self.lines)-1]
[705]124
[1019]125        if not hasattr(numbers, '__iter__'):
126            numbers = [numbers]
[705]127
[1019]128        for number in numbers:
129            if 0 <= number < len(self.lines):
130                if self.lines[number] is not None:
131                    for line in self.lines[number]:
132                        line.set_linestyle('None')
133                        self.lines[number] = None
134        self.show()
[705]135
136    def get_line(self):
[1019]137        """
138        Get the current default line attributes.
139        """
140        return self.attributes
[705]141
142
[1086]143    def hist(self, x=None, y=None, fmt=None, add=None):
[1019]144        """
145        Plot a histogram.  N.B. the x values refer to the start of the
146        histogram bin.
[705]147
[1019]148        fmt is the line style as in plot().
149        """
[1739]150        from numpy import array
151        from numpy.ma import MaskedArray
[1019]152        if x is None:
153            if y is None: return
[1023]154            x = range(len(y))
[705]155
[1019]156        if len(x) != len(y):
157            return
158        l2 = 2*len(x)
[1023]159        x2 = range(l2)
[1086]160        y2 = range(12)
[1023]161        y2 = range(l2)
162        m2 = range(l2)
[1553]163        ymsk = None
164        ydat = None
165        if hasattr(y, "raw_mask"):
166            # numpy < 1.1
167            ymsk = y.raw_mask()
168            ydat = y.raw_data()
169        else:
170            ymsk = y.mask
171            ydat = y.data
[1023]172        for i in range(l2):
[1019]173            x2[i] = x[i/2]
[1086]174            m2[i] = ymsk[i/2]
[705]175
[1023]176        y2[0] = 0.0
[1019]177        for i in range(1,l2):
[1086]178            y2[i] = ydat[(i-1)/2]
[705]179
[1086]180        self.plot(x2, MaskedArray(y2,mask=m2,copy=0), fmt, add)
[705]181
182
183    def hold(self, hold=True):
[1019]184        """
185        Buffer graphics until subsequently released.
186        """
187        self.buffering = hold
[705]188
189
190    def legend(self, loc=None):
[1019]191        """
192        Add a legend to the plot.
[705]193
[1019]194        Any other value for loc else disables the legend:
195             1: upper right
196             2: upper left
197             3: lower left
198             4: lower right
199             5: right
200             6: center left
201             7: center right
202             8: lower center
203             9: upper center
204            10: center
[705]205
[1019]206        """
[1095]207        if isinstance(loc, int):
[1098]208            self.loc = None
209            if 0 <= loc <= 10: self.loc = loc
[1095]210        else:
211            self.loc = None
212        #self.show()
[705]213
214
[1086]215    def plot(self, x=None, y=None, fmt=None, add=None):
[1019]216        """
217        Plot the next line in the current frame using the current line
218        attributes.  The ASAPlot graphics window will be mapped and raised.
[705]219
[1019]220        The argument list works a bit like the matlab plot() function.
221        """
222        if x is None:
223            if y is None: return
224            x = range(len(y))
[705]225
[1019]226        elif y is None:
227            y = x
228            x = range(len(y))
[1086]229        if fmt is None:
230            line = self.axes.plot(x, y)
[1019]231        else:
[1086]232            line = self.axes.plot(x, y, fmt)
[1980]233        # add a picker to lines for spectral value mode.
234        # matplotlib.axes.plot returns a list of line object (1 element)
235        line[0].set_picker(5.0)
[705]236
[1019]237        # Add to an existing line?
[1086]238        i = None
[1019]239        if add is None or len(self.lines) < add < 0:
240            # Don't add.
241            self.lines.append(line)
242            i = len(self.lines) - 1
243        else:
244            if add == 0: add = len(self.lines)
245            i = add - 1
246            self.lines[i].extend(line)
[705]247
[1019]248        # Set/reset attributes for the line.
249        gotcolour = False
250        for k, v in self.attributes.iteritems():
251            if k == 'color': gotcolour = True
252            for segment in self.lines[i]:
253                getattr(segment, "set_%s"%k)(v)
[705]254
[1019]255        if not gotcolour and len(self.colormap):
256            for segment in self.lines[i]:
257                getattr(segment, "set_color")(self.colormap[self.color])
[710]258                if len(self.colormap)  == 1:
259                    getattr(segment, "set_dashes")(self.linestyles[self.linestyle])
[1086]260
[1019]261            self.color += 1
262            if self.color >= len(self.colormap):
263                self.color = 0
[705]264
[710]265            if len(self.colormap) == 1:
266                self.linestyle += 1
[1019]267            if self.linestyle >= len(self.linestyles):
268                self.linestyle = 0
[710]269
[1019]270        self.show()
[705]271
272
273    def position(self):
[1019]274        """
275        Use the mouse to get a position from a graph.
276        """
[705]277
[1019]278        def position_disable(event):
279            self.register('button_press', None)
280            print '%.4f, %.4f' % (event.xdata, event.ydata)
[705]281
[1019]282        print 'Press any mouse button...'
283        self.register('button_press', position_disable)
[705]284
285
[1546]286    def get_region(self):
287        pos = []
[1568]288        print "Please select the bottom/left point"
[1546]289        pos.append(self.figure.ginput(n=1, show_clicks=False)[0])
[1568]290        print "Please select the top/right point"
[1546]291        pos.append(self.figure.ginput(n=1, show_clicks=False)[0])
292        return pos
293
294    def get_point(self):
[1568]295        print "Please select the point"
[1553]296        pt = self.figure.ginput(n=1, show_clicks=False)
297        if pt:
298            return pt[0]
299        else:
300            return None
[1546]301
[705]302    def region(self):
[1019]303        """
304        Use the mouse to get a rectangular region from a plot.
[705]305
[1019]306        The return value is [x0, y0, x1, y1] in world coordinates.
307        """
[705]308
[1019]309        def region_start(event):
[1819]310            self.rect = {'x': event.x, 'y': event.y,
[1019]311                         'world': [event.xdata, event.ydata,
312                                   event.xdata, event.ydata]}
313            self.register('button_press', None)
314            self.register('motion_notify', region_draw)
315            self.register('button_release', region_disable)
[705]316
[1019]317        def region_draw(event):
[1819]318            self.figmgr.toolbar.draw_rubberband(event, event.x, event.y,
319                                                self.rect['x'], self.rect['y'])
[1826]320
[1019]321        def region_disable(event):
322            self.register('motion_notify', None)
323            self.register('button_release', None)
[705]324
[1019]325            self.rect['world'][2:4] = [event.xdata, event.ydata]
326            print '(%.2f, %.2f)  (%.2f, %.2f)' % (self.rect['world'][0],
327                self.rect['world'][1], self.rect['world'][2],
328                self.rect['world'][3])
[1819]329            self.figmgr.toolbar.release(event)
[705]330
[1019]331        self.register('button_press', region_start)
[705]332
[1019]333        # This has to be modified to block and return the result (currently
334        # printed by region_disable) when that becomes possible in matplotlib.
[705]335
[1019]336        return [0.0, 0.0, 0.0, 0.0]
[705]337
338
339    def register(self, type=None, func=None):
[1019]340        """
341        Register, reregister, or deregister events of type 'button_press',
342        'button_release', or 'motion_notify'.
[705]343
[1019]344        The specified callback function should have the following signature:
[705]345
[1019]346            def func(event)
[705]347
[1019]348        where event is an MplEvent instance containing the following data:
[705]349
[1019]350            name                # Event name.
351            canvas              # FigureCanvas instance generating the event.
352            x      = None       # x position - pixels from left of canvas.
353            y      = None       # y position - pixels from bottom of canvas.
354            button = None       # Button pressed: None, 1, 2, 3.
355            key    = None       # Key pressed: None, chr(range(255)), shift,
356                                  win, or control
357            inaxes = None       # Axes instance if cursor within axes.
358            xdata  = None       # x world coordinate.
359            ydata  = None       # y world coordinate.
[705]360
[1019]361        For example:
[705]362
[1019]363            def mouse_move(event):
364                print event.xdata, event.ydata
[705]365
[1019]366            a = asaplot()
367            a.register('motion_notify', mouse_move)
[705]368
[1019]369        If func is None, the event is deregistered.
[705]370
[1019]371        Note that in TkAgg keyboard button presses don't generate an event.
372        """
[705]373
[1019]374        if not self.events.has_key(type): return
[705]375
[1019]376        if func is None:
377            if self.events[type] is not None:
378                # It's not clear that this does anything.
379                self.canvas.mpl_disconnect(self.events[type])
380                self.events[type] = None
[705]381
[1819]382                # It seems to be necessary to return events to the toolbar. <-- Not ture. 2010.Jul.14.kana.
383                #if type == 'motion_notify':
384                #    self.canvas.mpl_connect(type + '_event',
385                #        self.figmgr.toolbar.mouse_move)
386                #elif type == 'button_press':
387                #    self.canvas.mpl_connect(type + '_event',
388                #        self.figmgr.toolbar.press)
389                #elif type == 'button_release':
390                #    self.canvas.mpl_connect(type + '_event',
391                #        self.figmgr.toolbar.release)
[705]392
[1019]393        else:
394            self.events[type] = self.canvas.mpl_connect(type + '_event', func)
[705]395
396
397    def release(self):
[1019]398        """
399        Release buffered graphics.
400        """
401        self.buffering = False
402        self.show()
[705]403
404
[1095]405    def save(self, fname=None, orientation=None, dpi=None, papertype=None):
[1019]406        """
407        Save the plot to a file.
[705]408
[1019]409        fname is the name of the output file.  The image format is determined
410        from the file suffix; 'png', 'ps', and 'eps' are recognized.  If no
411        file name is specified 'yyyymmdd_hhmmss.png' is created in the current
412        directory.
413        """
[1095]414        from asap import rcParams
415        if papertype is None:
416            papertype = rcParams['plotter.papertype']
[1019]417        if fname is None:
418            from datetime import datetime
419            dstr = datetime.now().strftime('%Y%m%d_%H%M%S')
420            fname = 'asap'+dstr+'.png'
[705]421
[1870]422        d = ['png','.ps','eps', 'svg']
[705]423
[1019]424        from os.path import expandvars
425        fname = expandvars(fname)
[705]426
[1019]427        if fname[-3:].lower() in d:
428            try:
[705]429                if fname[-3:].lower() == ".ps":
[1020]430                    from matplotlib import __version__ as mv
[1479]431                    w = self.figure.get_figwidth()
432                    h = self.figure.get_figheight()
[1019]433
[705]434                    if orientation is None:
[1147]435                        # oriented
[705]436                        if w > h:
437                            orientation = 'landscape'
438                        else:
439                            orientation = 'portrait'
[1095]440                    from matplotlib.backends.backend_ps import papersize
441                    pw,ph = papersize[papertype.lower()]
[1025]442                    ds = None
443                    if orientation == 'landscape':
[1095]444                        ds = min(ph/w, pw/h)
[1025]445                    else:
[1095]446                        ds = min(pw/w, ph/h)
[1025]447                    ow = ds * w
448                    oh = ds * h
[1479]449                    self.figure.set_size_inches((ow, oh))
[1095]450                    self.figure.savefig(fname, orientation=orientation,
451                                        papertype=papertype.lower())
[1479]452                    self.figure.set_size_inches((w, h))
[705]453                    print 'Written file %s' % (fname)
[1019]454                else:
[705]455                    if dpi is None:
456                        dpi =150
[1025]457                    self.figure.savefig(fname,dpi=dpi)
[705]458                    print 'Written file %s' % (fname)
[1019]459            except IOError, msg:
[1819]460                #print 'Failed to save %s: Error msg was\n\n%s' % (fname, err)
[1861]461                asaplog.post()
[1819]462                asaplog.push('Failed to save %s: Error msg was\n\n%s' % (fname, str(msg)))
[1861]463                asaplog.post( 'ERROR' )
[1019]464                return
465        else:
[1819]466            #print "Invalid image type. Valid types are:"
467            #print "'ps', 'eps', 'png'"
468            asaplog.push( "Invalid image type. Valid types are:" )
[1870]469            asaplog.push( "'ps', 'eps', 'png', 'svg'" )
[1861]470            asaplog.post('WARN')
[705]471
472
473    def set_axes(self, what=None, *args, **kwargs):
[1019]474        """
475        Set attributes for the axes by calling the relevant Axes.set_*()
476        method.  Colour translation is done as described in the doctext
477        for palette().
478        """
[705]479
[1019]480        if what is None: return
481        if what[-6:] == 'colour': what = what[:-6] + 'color'
[705]482
[1153]483        key = "colour"
484        if kwargs.has_key(key):
485            val = kwargs.pop(key)
486            kwargs["color"] = val
[705]487
[1153]488        getattr(self.axes, "set_%s"%what)(*args, **kwargs)
[705]489
[1153]490        self.show(hardrefresh=False)
[705]491
[1019]492
[705]493    def set_figure(self, what=None, *args, **kwargs):
[1019]494        """
495        Set attributes for the figure by calling the relevant Figure.set_*()
496        method.  Colour translation is done as described in the doctext
497        for palette().
498        """
[705]499
[1019]500        if what is None: return
501        if what[-6:] == 'colour': what = what[:-6] + 'color'
502        #if what[-5:] == 'color' and len(args):
503        #    args = (get_colour(args[0]),)
[705]504
[1019]505        newargs = {}
506        for k, v in kwargs.iteritems():
507            k = k.lower()
508            if k == 'colour': k = 'color'
509            newargs[k] = v
[705]510
[1019]511        getattr(self.figure, "set_%s"%what)(*args, **newargs)
[1153]512        self.show(hardrefresh=False)
[705]513
514
515    def set_limits(self, xlim=None, ylim=None):
[1019]516        """
517        Set x-, and y-limits for each subplot.
[705]518
[1019]519        xlim = [xmin, xmax] as in axes.set_xlim().
520        ylim = [ymin, ymax] as in axes.set_ylim().
521        """
522        for s in self.subplots:
523            self.axes  = s['axes']
524            self.lines = s['lines']
[705]525            oldxlim =  list(self.axes.get_xlim())
526            oldylim =  list(self.axes.get_ylim())
527            if xlim is not None:
528                for i in range(len(xlim)):
529                    if xlim[i] is not None:
530                        oldxlim[i] = xlim[i]
[1019]531            if ylim is not None:
[705]532                for i in range(len(ylim)):
533                    if ylim[i] is not None:
534                        oldylim[i] = ylim[i]
535            self.axes.set_xlim(oldxlim)
536            self.axes.set_ylim(oldylim)
537        return
538
539
540    def set_line(self, number=None, **kwargs):
[1019]541        """
542        Set attributes for the specified line, or else the next line(s)
543        to be plotted.
[705]544
[1019]545        number is the 0-relative number of a line that has already been
546        plotted.  If no such line exists, attributes are recorded and used
547        for the next line(s) to be plotted.
[705]548
[1019]549        Keyword arguments specify Line2D attributes, e.g. color='r'.  Do
[705]550
[1019]551            import matplotlib
552            help(matplotlib.lines)
[705]553
[1019]554        The set_* methods of class Line2D define the attribute names and
555        values.  For non-US usage, "colour" is recognized as synonymous with
556        "color".
[705]557
[1019]558        Set the value to None to delete an attribute.
[705]559
[1019]560        Colour translation is done as described in the doctext for palette().
561        """
[705]562
[1019]563        redraw = False
564        for k, v in kwargs.iteritems():
565            k = k.lower()
566            if k == 'colour': k = 'color'
[705]567
[1019]568            if 0 <= number < len(self.lines):
569                if self.lines[number] is not None:
570                    for line in self.lines[number]:
571                        getattr(line, "set_%s"%k)(v)
572                    redraw = True
573            else:
574                if v is None:
575                    del self.attributes[k]
576                else:
577                    self.attributes[k] = v
[705]578
[1153]579        if redraw: self.show(hardrefresh=False)
[705]580
581
[1819]582    #def set_panels(self, rows=1, cols=0, n=-1, nplots=-1, ganged=True):
[2037]583    def set_panels(self, rows=1, cols=0, n=-1, nplots=-1, margin=None,ganged=True):
[1019]584        """
585        Set the panel layout.
[705]586
[1019]587        rows and cols, if cols != 0, specify the number of rows and columns in
588        a regular layout.   (Indexing of these panels in matplotlib is row-
589        major, i.e. column varies fastest.)
[705]590
[1019]591        cols == 0 is interpreted as a retangular layout that accomodates
592        'rows' panels, e.g. rows == 6, cols == 0 is equivalent to
593        rows == 2, cols == 3.
[705]594
[1019]595        0 <= n < rows*cols is interpreted as the 0-relative panel number in
596        the configuration specified by rows and cols to be added to the
597        current figure as its next 0-relative panel number (i).  This allows
598        non-regular panel layouts to be constructed via multiple calls.  Any
599        other value of n clears the plot and produces a rectangular array of
600        empty panels.  The number of these may be limited by nplots.
601        """
602        if n < 0 and len(self.subplots):
603            self.figure.clear()
604            self.set_title()
[705]605
[2037]606        if margin:
607            lef, bot, rig, top, wsp, hsp = margin
[1819]608            self.figure.subplots_adjust(
609                left=lef,bottom=bot,right=rig,top=top,wspace=wsp,hspace=hsp)
610            del lef,bot,rig,top,wsp,hsp
611
[1019]612        if rows < 1: rows = 1
[705]613
[1019]614        if cols <= 0:
615            i = int(sqrt(rows))
616            if i*i < rows: i += 1
617            cols = i
[705]618
[1019]619            if i*(i-1) >= rows: i -= 1
620            rows = i
[705]621
[1019]622        if 0 <= n < rows*cols:
623            i = len(self.subplots)
[1819]624
[1019]625            self.subplots.append({})
[705]626
[1019]627            self.subplots[i]['axes']  = self.figure.add_subplot(rows,
628                                            cols, n+1)
629            self.subplots[i]['lines'] = []
[705]630
[1019]631            if i == 0: self.subplot(0)
[705]632
[1019]633            self.rows = 0
634            self.cols = 0
[705]635
[1019]636        else:
637            self.subplots = []
[705]638
[1019]639            if nplots < 1 or rows*cols < nplots:
640                nplots = rows*cols
[1025]641            if ganged:
642                hsp,wsp = None,None
643                if rows > 1: hsp = 0.0001
644                if cols > 1: wsp = 0.0001
645                self.figure.subplots_adjust(wspace=wsp,hspace=hsp)
[1019]646            for i in range(nplots):
647                self.subplots.append({})
[1153]648                self.subplots[i]['lines'] = []
649                if not ganged:
650                    self.subplots[i]['axes'] = self.figure.add_subplot(rows,
[1019]651                                                cols, i+1)
[1560]652                    if asaprcParams['plotter.axesformatting'] != 'mpl':
[1513]653                        self.subplots[i]['axes'].xaxis.set_major_formatter(OldScalarFormatter())
[1153]654                else:
655                    if i == 0:
656                        self.subplots[i]['axes'] = self.figure.add_subplot(rows,
657                                                cols, i+1)
[1560]658                        if asaprcParams['plotter.axesformatting'] != 'mpl':
[1826]659
[1513]660                            self.subplots[i]['axes'].xaxis.set_major_formatter(OldScalarFormatter())
[1153]661                    else:
662                        self.subplots[i]['axes'] = self.figure.add_subplot(rows,
663                                                cols, i+1,
664                                                sharex=self.subplots[0]['axes'],
665                                                sharey=self.subplots[0]['axes'])
[1259]666
[705]667                    # Suppress tick labelling for interior subplots.
668                    if i <= (rows-1)*cols - 1:
669                        if i+cols < nplots:
670                            # Suppress x-labels for frames width
671                            # adjacent frames
[1153]672                            for tick in self.subplots[i]['axes'].xaxis.majorTicks:
673                                tick.label1On = False
[1926]674                            #self.subplots[i]['axes'].xaxis.label.set_visible(False)
[705]675                    if i%cols:
676                        # Suppress y-labels for frames not in the left column.
677                        for tick in self.subplots[i]['axes'].yaxis.majorTicks:
678                            tick.label1On = False
[1926]679                        #self.subplots[i]['axes'].yaxis.label.set_visible(False)
[1025]680                    # disable the first tick of [1:ncol-1] of the last row
[1153]681                    #if i+1 < nplots:
682                    #    self.subplots[i]['axes'].xaxis.majorTicks[0].label1On = False
[1926]683                # set axes label state for interior subplots.
684                if i%cols:
685                    self.subplots[i]['axes'].yaxis.label.set_visible(False)
686                if (i <= (rows-1)*cols - 1) and (i+cols < nplots):
687                    self.subplots[i]['axes'].xaxis.label.set_visible(False)
688            self.rows = rows
689            self.cols = cols
[1019]690            self.subplot(0)
[2037]691        del rows,cols,n,nplots,margin,ganged,i
[705]692
[1926]693
[1153]694    def tidy(self):
695        # this needs to be exceuted after the first "refresh"
696        nplots = len(self.subplots)
697        if nplots == 1: return
698        for i in xrange(nplots):
699            ax = self.subplots[i]['axes']
700            if i%self.cols:
701                ax.xaxis.majorTicks[0].label1On = False
702            else:
703                if i != 0:
704                    ax.yaxis.majorTicks[-1].label1On = False
[1926]705            ## set axes label state for interior subplots.
706            #innerax=False
707            #if i%self.cols:
708            #    ax.yaxis.label.set_visible(innerax)
709            #if (i <= (self.rows-1)*self.cols - 1) and (i+self.cols < nplots):
710            #    ax.xaxis.label.set_visible(innerax)
711           
[1153]712
[705]713    def set_title(self, title=None):
[1019]714        """
715        Set the title of the plot window.  Use the previous title if title is
716        omitted.
717        """
718        if title is not None:
719            self.title = title
[705]720
[1019]721        self.figure.text(0.5, 0.95, self.title, horizontalalignment='center')
[705]722
723
[1153]724    def show(self, hardrefresh=True):
[1019]725        """
726        Show graphics dependent on the current buffering state.
727        """
[1153]728        if not hardrefresh: return
[1019]729        if not self.buffering:
730            if self.loc is not None:
[1086]731                for sp in self.subplots:
[1019]732                    lines  = []
733                    labels = []
734                    i = 0
[1086]735                    for line in sp['lines']:
[1019]736                        i += 1
737                        if line is not None:
738                            lines.append(line[0])
739                            lbl = line[0].get_label()
740                            if lbl == '':
741                                lbl = str(i)
742                            labels.append(lbl)
[705]743
[1019]744                    if len(lines):
[1147]745                        fp = FP(size=rcParams['legend.fontsize'])
[2069]746                        #fsz = fp.get_size_in_points() - len(lines)
747                        fsz = fp.get_size_in_points() - max(len(lines),self.cols)
748                        #fp.set_size(max(fsz,6))
749                        fp.set_size(max(fsz,8))
[1086]750                        sp['axes'].legend(tuple(lines), tuple(labels),
[1147]751                                          self.loc, prop=fp)
[1946]752                    #else:
753                    #    sp['axes'].legend((' '))
[705]754
[1086]755            from matplotlib.artist import setp
[1560]756            fpx = FP(size=rcParams['xtick.labelsize'])
757            xts = fpx.get_size_in_points()- (self.cols)/2
758            fpy = FP(size=rcParams['ytick.labelsize'])
759            yts = fpy.get_size_in_points() - (self.rows)/2
760            fpa = FP(size=rcParams['axes.labelsize'])
761            fpat = FP(size=rcParams['axes.titlesize'])
762            axsize =  fpa.get_size_in_points()
[1819]763            tsize =  fpat.get_size_in_points()-(self.cols)/2
[1086]764            for sp in self.subplots:
765                ax = sp['axes']
[1819]766                ax.title.set_size(tsize)
[1086]767                setp(ax.get_xticklabels(), fontsize=xts)
768                setp(ax.get_yticklabels(), fontsize=yts)
769                off = 0
[1819]770                if self.cols > 1: off = self.cols
[1560]771                ax.xaxis.label.set_size(axsize-off)
[1819]772                off = 0
773                if self.rows > 1: off = self.rows
[1560]774                ax.yaxis.label.set_size(axsize-off)
[705]775
776    def subplot(self, i=None, inc=None):
[1019]777        """
778        Set the subplot to the 0-relative panel number as defined by one or
779        more invokations of set_panels().
780        """
781        l = len(self.subplots)
782        if l:
783            if i is not None:
784                self.i = i
[705]785
[1019]786            if inc is not None:
787                self.i += inc
[705]788
[1019]789            self.i %= l
790            self.axes  = self.subplots[self.i]['axes']
791            self.lines = self.subplots[self.i]['lines']
[705]792
793    def text(self, *args, **kwargs):
[1019]794        """
795        Add text to the figure.
796        """
797        self.figure.text(*args, **kwargs)
798        self.show()
[1147]799
800    def vline_with_label(self, x, y, label,
801                         location='bottom', rotate=0.0, **kwargs):
802        """
803        Plot a vertical line with label.
804        It takes "world" values fo x and y.
805        """
806        ax = self.axes
807        # need this to suppress autoscaling during this function
808        self.axes.set_autoscale_on(False)
809        ymin = 0.0
810        ymax = 1.0
811        valign = 'center'
812        if location.lower() == 'top':
813            y = max(0.0, y)
814        elif location.lower() == 'bottom':
815            y = min(0.0, y)
816        lbloffset = 0.06
817        # a rough estimate for the bb of the text
818        if rotate > 0.0: lbloffset = 0.03*len(label)
819        peakoffset = 0.01
[1535]820        xy = None
821        xy0 = None
822        # matplotlib api change 0.98 is using transform now
823        if hasattr(ax.transData, "inverse_xy_tup"):
824            # get relative coords
825            xy0 = ax.transData.xy_tup((x,y))
826            xy = ax.transAxes.inverse_xy_tup(xy0)
827        else:
828            xy0 = ax.transData.transform((x,y))
829            # get relative coords
830            xy = ax.transAxes.inverted().transform(xy0)
[1147]831        if location.lower() == 'top':
832            ymax = 1.0-lbloffset
833            ymin = xy[1]+peakoffset
834            valign = 'bottom'
835            ylbl = ymax+0.01
836        elif location.lower() == 'bottom':
837            ymin = lbloffset
838            ymax = xy[1]-peakoffset
839            valign = 'top'
840            ylbl = ymin-0.01
[1425]841        trans = blended_transform_factory(ax.transData, ax.transAxes)
[1147]842        l = ax.axvline(x, ymin, ymax, color='black', **kwargs)
843        t = ax.text(x, ylbl ,label, verticalalignment=valign,
844                                    horizontalalignment='center',
845                    rotation=rotate,transform = trans)
846        self.axes.set_autoscale_on(True)
Note: See TracBrowser for help on using the repository browser.