source: trunk/python/casatoolbar.py @ 2053

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

New Development: No (a bug fix)

JIRA Issue: Yes (CAS-2764, ATNF-238)

Ready for Test: Yes

Interface Changes: Yes

What Interface Changed: added asapplotter.clear_header method to clear plotted header.

Test Programs: plot spectra without header and go back and forth the pages. you should not see header plotted anymore.

Put in Release Notes: No

Module(s): asapplotter, sdplot

Description:

Fixed a bug which I introduced yesterday.
Header information is not printed on a plotter when you don't mean to plot it.


File size: 16.0 KB
Line 
1import os
2import matplotlib, numpy
3from asap.logging import asaplog, asaplog_post_dec
4
5######################################
6##    Add CASA custom toolbar       ##
7######################################
8class CustomToolbarCommon:
9    def __init__(self,parent):
10        self.plotter=parent
11        #self.figmgr=self.plotter._plotter.figmgr
12
13    ### select the nearest spectrum in pick radius
14    ###    and display spectral value on the toolbar.
15    def _select_spectrum(self,event):
16        # Do not fire event when in zooming/panning mode
17        mode = self.figmgr.toolbar.mode
18        if not mode == '':
19            return
20            # When selected point is out of panels
21        if event.inaxes == None:
22            return
23        # If not left button
24        if event.button != 1:
25            return
26
27        xclick=event.xdata
28        yclick=event.ydata
29        dist2=1000.
30        pickline=None
31        # If the pannel has picable objects
32        pflag=False
33        for lin in event.inaxes.lines:
34            if not lin.pickable():
35                continue
36            pflag=True
37            flag,pind = lin.contains(event)
38            if not flag:
39                continue
40            # Get nearest point
41            inds = pind['ind']
42            xlin = lin.get_xdata()
43            ylin = lin.get_ydata()
44            for i in inds:
45                d2=(xlin[i]-xclick)**2+(ylin[i]-yclick)**2
46                if dist2 >= d2:
47                    dist2 = d2
48                    pickline = lin
49        # No pickcable line in the pannel
50        if not pflag:
51            return
52        # Pickable but too far from mouse position
53        elif pickline is None:
54            picked='No line selected.'
55            self.figmgr.toolbar.set_message(picked)
56            return
57        del pind, inds, xlin, ylin
58        # Spectra are Picked
59        theplot = self.plotter._plotter
60        thetoolbar = self.figmgr.toolbar
61        thecanvas = self.figmgr.canvas
62        # Disconnect the default motion notify event
63        # Notice! the other buttons are also diabled!!!
64        thecanvas.mpl_disconnect(thetoolbar._idDrag)
65        # Get picked spectrum
66        xdata = pickline.get_xdata()
67        ydata = pickline.get_ydata()
68        titl=pickline.get_label()
69        titp=event.inaxes.title.get_text()
70        panel0=event.inaxes
71        picked="Selected: '"+titl+"' in panel '"+titp+"'."
72        thetoolbar.set_message(picked)
73        # Generate a navigation window
74        #naviwin=Navigationwindow(titp,titl)
75        #------------------------------------------------------#
76        # Show spectrum data at mouse position
77        def spec_data(event):
78            # Getting spectrum data of neiboring point
79            xclick=event.xdata
80            if event.inaxes != panel0:
81                return
82            ipoint=len(xdata)-1
83            for i in range(len(xdata)-1):
84                xl=xclick-xdata[i]
85                xr=xclick-xdata[i+1]
86                if xl*xr <= 0.:
87                    ipoint = i
88                    break
89            # Output spectral value on the navigation window
90            posi='[ %s, %s ]:  x = %.2f   value = %.2f'\
91                  %(titl,titp,xdata[ipoint],ydata[ipoint])
92            #naviwin.posi.set(posi)
93            thetoolbar.set_message(posi)
94        #------------------------------------------------------#
95        # Disconnect from mouse events
96        def discon(event):
97            #naviwin.window.destroy()
98            theplot.register('motion_notify',None)
99            # Re-activate the default motion_notify_event
100            thetoolbar._idDrag=thecanvas.mpl_connect('motion_notify_event',
101                                                     thetoolbar.mouse_move)
102            theplot.register('button_release',None)
103            return
104        #------------------------------------------------------#
105        # Show data value along with mouse movement
106        theplot.register('motion_notify',spec_data)
107        # Finish events when mouse button is released
108        theplot.register('button_release',discon)
109
110
111    ### Calculate statistics of the selected area.
112    def _single_mask(self,event):
113        # Do not fire event when in zooming/panning mode
114        if not self.figmgr.toolbar.mode == '':
115            return
116        # When selected point is out of panels
117        if event.inaxes == None:
118            return
119        if event.button ==1:
120            baseinv=True
121        elif event.button == 3:
122            baseinv=False
123        else:
124            return
125
126        def _calc_stats():
127            msk=mymask.get_mask()
128            mymask.scan.stats(stat='max',mask=msk)
129            mymask.scan.stats(stat='min',mask=msk)
130            mymask.scan.stats(stat='sum',mask=msk)
131            mymask.scan.stats(stat='mean',mask=msk)
132            mymask.scan.stats(stat='median',mask=msk)
133            mymask.scan.stats(stat='rms',mask=msk)
134            mymask.scan.stats(stat='stddev',mask=msk)
135
136        # Interactive mask definition
137        from asap.interactivemask import interactivemask
138        mymask=interactivemask(plotter=self.plotter,scan=self.plotter._data)
139        # Create initial mask
140        mymask.set_basemask(invert=baseinv)
141        # Inherit event
142        mymask.set_startevent(event)
143        # Set callback func
144        mymask.set_callback(_calc_stats)
145        # Selected mask
146        mymask.select_mask(once=True,showmask=False)
147
148    def _mod_note(self,event):
149        # Do not fire event when in zooming/panning mode
150        if not self.figmgr.toolbar.mode == '':
151            return
152        if event.button ==1:
153            self.notewin.load_textwindow(event)
154        elif event.button == 3 and self._note_picked(event):
155            self.notewin.load_modmenu(event)
156        return
157
158    def _note_picked(self,event):
159        # just briefly check if any texts are picked
160        for textobj in self.canvas.figure.texts:
161            if textobj.contains(event)[0]:
162                return True
163        for ax in self.canvas.figure.axes:
164            for textobj in ax.texts:
165                if textobj.contains(event)[0]:
166                    return True
167        #print "No text picked"
168        return False
169
170    ### Page chages
171    ### go to the previous page
172    def prev_page(self):
173        self.figmgr.toolbar.set_message('plotting the previous page')
174        self._new_page(goback=True)
175
176    ### go to the next page
177    def next_page(self):
178        self.figmgr.toolbar.set_message('plotting the next page')
179        self._new_page(goback=False)
180
181    ### actual plotting of the new page
182    def _new_page(self,goback=False):
183        top = None
184        header = self.plotter._headtext
185        reset = False
186        doheader = (isinstance(header['textobj'],list) and \
187                    len(header['textobj']) > 0)
188        if self.plotter._startrow <= 0:
189            msg = "The page counter is reset due to chages of plot settings. "
190            msg += "Plotting from the first page."
191            asaplog.push(msg)
192            asaplog.post('WARN')
193            reset = True
194            goback = False
195            if doheader:
196                extrastr = selstr = ''
197                if header.has_key('extrastr'):
198                    extrastr = header['extrastr']
199                if header.has_key('selstr'):
200                    selstr = header['selstr']
201            self.plotter._reset_header()
202        if doheader:
203            top = self.plotter._plotter.figure.subplotpars.top
204            fontsize = header['textobj'][0].get_fontproperties().get_size()
205
206        self.plotter._plotter.hold()
207        if goback:
208            self._set_prevpage_counter()
209        #self.plotter._plotter.clear()
210        self.plotter._plot(self.plotter._data)
211        self.set_pagecounter(self._get_pagenum())
212        # Plot header information
213        if header['textobj']:
214            if top and top != self.plotter._margins[3]:
215                # work around for sdplot in CASA. complete checking in future?
216                self.plotter._plotter.figure.subplots_adjust(top=top)
217            if reset:
218                self.plotter.print_header(plot=True,fontsize=fontsize,selstr=selstr, extrastr=extrastr)
219            else:
220                self.plotter._header_plot(header['string'],fontsize=fontsize)
221        self.plotter._plotter.release()
222        self.plotter._plotter.tidy()
223        self.plotter._plotter.show(hardrefresh=False)
224        del top
225
226    ### calculate the panel ID and start row to plot the previous page
227    def _set_prevpage_counter(self):
228        # set row and panel counters to those of the 1st panel of previous page
229        maxpanel = 16
230        # the ID of the last panel in current plot
231        lastpanel = self.plotter._ipanel
232        # the number of current subplots
233        currpnum = len(self.plotter._plotter.subplots)
234        # the nuber of previous subplots
235        prevpnum = None
236        if self.plotter._rows and self.plotter._cols:
237            # when user set layout
238            prevpnum = self.plotter._rows*self.plotter._cols
239        else:
240            # no user specification
241            prevpnum = maxpanel
242           
243        start_ipanel = max(lastpanel-currpnum-prevpnum+1, 0)
244        # set the pannel ID of the last panel of prev-prev page
245        self.plotter._ipanel = start_ipanel-1
246        if self.plotter._panelling == 'r':
247            self.plotter._startrow = start_ipanel
248        else:
249            # the start row number of the next panel
250            self.plotter._startrow = self.plotter._panelrows[start_ipanel]
251        del lastpanel,currpnum,prevpnum,start_ipanel
252
253    ### refresh the page counter
254    ### refresh the page counter
255    def set_pagecounter(self,page):
256        nwidth = int(numpy.ceil(numpy.log10(max(page,1))))+1
257        nwidth = max(nwidth,4)
258        formatstr = '%'+str(nwidth)+'d'
259        self.show_pagenum(page,formatstr)
260
261    def show_pagenum(self,pagenum,formatstr):
262        # passed to backend dependent class
263        pass       
264
265    def _get_pagenum(self):
266        maxpanel = 16
267        # get the ID of last panel in the current page
268        idlastpanel = self.plotter._ipanel
269        if self.plotter._rows and self.plotter._cols:
270            ppp = self.plotter._rows*self.plotter._cols
271        else:
272            ppp = maxpanel
273        return int(idlastpanel/ppp)+1
274
275#####################################
276##    Backend dependent Classes    ##
277#####################################
278### TkAgg
279if matplotlib.get_backend() == 'TkAgg':
280    import Tkinter as Tk
281    from notationwindow import NotationWindowTkAgg
282
283class CustomToolbarTkAgg(CustomToolbarCommon, Tk.Frame):
284    def __init__(self,parent):
285        from asap.asapplotter import asapplotter
286        if not isinstance(parent,asapplotter):
287            return False
288        if not parent._plotter:
289            return False
290        self._p = parent._plotter
291        self.figmgr = self._p.figmgr
292        self.canvas = self.figmgr.canvas
293        self.mode = ''
294        self.button = True
295        self.pagecount = None
296        CustomToolbarCommon.__init__(self,parent)
297        self.notewin=NotationWindowTkAgg(master=self.canvas)
298        self._add_custom_toolbar()
299
300    def _add_custom_toolbar(self):
301        Tk.Frame.__init__(self,master=self.figmgr.window)
302        #self.bSpec=self._NewButton(master=self,
303        #                           text='spec value',
304        #                           command=self.spec_show)
305        self.bNote=self._NewButton(master=self,
306                                   text='notation',
307                                   command=self.modify_note)
308
309        self.bStat=self._NewButton(master=self,
310                                   text='statistics',
311                                   command=self.stat_cal)
312        self.bQuit=self._NewButton(master=self,
313                                   text='Quit',
314                                   command=self.quit,
315                                   side=Tk.RIGHT)
316
317        # page change oparations
318        frPage = Tk.Frame(master=self,borderwidth=2,relief=Tk.GROOVE)
319        frPage.pack(ipadx=2,padx=10,side=Tk.RIGHT)
320        self.lPagetitle = Tk.Label(master=frPage,text='Page:',padx=5)
321        self.lPagetitle.pack(side=Tk.LEFT)
322        self.pagecount = Tk.StringVar(master=frPage)
323        self.lPagecount = Tk.Label(master=frPage,
324                                   textvariable=self.pagecount,
325                                   padx=5,bg='white')
326        self.lPagecount.pack(side=Tk.LEFT,padx=3)
327       
328        self.bNext=self._NewButton(master=frPage,
329                                   text=' + ',
330                                   command=self.next_page)
331        self.bPrev=self._NewButton(master=frPage,
332                                   text=' - ',
333                                   command=self.prev_page)
334
335        if os.uname()[0] != 'Darwin':
336            self.bPrev.config(padx=5)
337            self.bNext.config(padx=5)
338
339        self.pack(side=Tk.BOTTOM,fill=Tk.BOTH)
340        self.pagecount.set(' '*4)
341
342        self.disable_button()
343        return #self
344
345    def _NewButton(self, master, text, command, side=Tk.LEFT):
346        if os.uname()[0] == 'Darwin':
347            b = Tk.Button(master=master, text=text, command=command)
348        else:
349            b = Tk.Button(master=master, text=text, padx=2, pady=2,
350                          command=command)
351        b.pack(side=side)
352        return b
353
354    def show_pagenum(self,pagenum,formatstr):
355        self.pagecount.set(formatstr % (pagenum))
356
357    def spec_show(self):
358        if not self.figmgr.toolbar.mode == '' or not self.button: return
359        self.figmgr.toolbar.set_message('spec value: drag on a spec')
360        if self.mode == 'spec': return
361        #self.bStat.config(relief='raised')
362        #self.bSpec.config(relief='sunken')
363        #self.bNote.config(relief='raised')
364        self.mode='spec'
365        self.notewin.close_widgets()
366        self.__disconnect_event()
367        self._p.register('button_press',self._select_spectrum)
368
369    def stat_cal(self):
370        if not self.figmgr.toolbar.mode == '' or not self.button: return
371        self.figmgr.toolbar.set_message('statistics: select a region')
372        if self.mode == 'stat':
373            # go back to spec mode
374            self.bStat.config(relief='raised')
375            self.spec_show()
376            return
377        #self.bSpec.config(relief='raised')
378        self.bStat.config(relief='sunken')
379        self.bNote.config(relief='raised')
380        self.mode='stat'
381        self.notewin.close_widgets()
382        self.__disconnect_event()
383        self._p.register('button_press',self._single_mask)
384
385    def modify_note(self):
386        if not self.figmgr.toolbar.mode == '': return
387        self.figmgr.toolbar.set_message('text: select a position/text')
388        if self.mode == 'note':
389            self.bNote.config(relief='raised')
390            self.mode='none'
391            self.spec_show()
392            return
393        #self.bSpec.config(relief='raised')
394        self.bStat.config(relief='raised')
395        self.bNote.config(relief='sunken')
396        self.mode='note'
397        self.__disconnect_event()
398        self._p.register('button_press',self._mod_note)
399
400    def quit(self):
401        self.__disconnect_event()
402        #self.delete_bar()
403        self.disable_button()
404        self.figmgr.window.wm_withdraw()
405
406    def enable_button(self):
407        if self.button: return
408        #self.bSpec.config(state=Tk.NORMAL)
409        self.bStat.config(state=Tk.NORMAL)
410        self.button=True
411        self.spec_show()
412
413    def disable_button(self):
414        if not self.button: return
415        #self.bSpec.config(relief='raised', state=Tk.DISABLED)
416        self.bStat.config(relief='raised', state=Tk.DISABLED)
417        #self.bNext.config(state=Tk.DISABLED)
418        #self.bPrev.config(state=Tk.DISABLED)
419        self.button=False
420        self.mode=''
421        self.__disconnect_event()
422
423    def enable_next(self):
424        self.bNext.config(state=Tk.NORMAL)
425
426    def disable_next(self):
427        self.bNext.config(state=Tk.DISABLED)
428
429    def enable_prev(self):
430        self.bPrev.config(state=Tk.NORMAL)
431
432    def disable_prev(self):
433        self.bPrev.config(state=Tk.DISABLED)
434
435    def delete_bar(self):
436        self.__disconnect_event()
437        self.destroy()
438
439    def __disconnect_event(self):
440        self._p.register('button_press',None)
441        self._p.register('button_release',None)
Note: See TracBrowser for help on using the repository browser.