source: sasview/sansguiframe/src/sans/guiframe/local_perspectives/plotting/Plotter1D.py @ f8be87d

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since f8be87d was f8be87d, checked in by Kieran Campbell <kieranrcampbell@…>, 12 years ago

Changes to include 1D appearance dialog
  • Property mode set to 100644
File size: 23.9 KB
Line 
1
2################################################################################
3#This software was developed by the University of Tennessee as part of the
4#Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
5#project funded by the US National Science Foundation.
6#
7#See the license text in license.txt
8#
9#copyright 2008, University of Tennessee
10################################################################################
11
12
13import wx
14import sys
15import os
16import pylab
17import math
18import numpy
19import time
20
21from danse.common.plottools.PlotPanel import PlotPanel
22from danse.common.plottools.SizeDialog import SizeDialog
23from danse.common.plottools.LabelDialog import LabelDialog
24#from danse.common.plottools.plottables import Graph
25from sans.guiframe import dataFitting
26from sans.guiframe.events import EVT_NEW_PLOT
27from sans.guiframe.events import StatusEvent
28from sans.guiframe.events import NewPlotEvent
29from sans.guiframe.events import NewColorEvent
30from sans.guiframe.events import SlicerEvent
31from sans.guiframe.events import PanelOnFocusEvent
32from sans.guiframe.events import EVT_NEW_LOADED_DATA
33from sans.guiframe.utils import PanelMenu
34from sans.guiframe.dataFitting import Data1D
35from sans.guiframe.panel_base import PanelBase
36from sans.guiframe.gui_style import GUIFRAME_ICON
37from binder import BindArtist
38from appearanceDialog import appearanceDialog
39
40DEFAULT_QMAX = 0.05
41DEFAULT_QSTEP = 0.001
42DEFAULT_BEAM = 0.005
43BIN_WIDTH = 1
44IS_MAC = (sys.platform == 'darwin')
45
46class ModelPanel1D(PlotPanel, PanelBase):
47    """
48    Plot panel for use with the GUI manager
49    """
50   
51    ## Internal name for the AUI manager
52    window_name = "plotpanel"
53    ## Title to appear on top of the window
54    window_caption = "Graph"
55    ## Flag to tell the GUI manager that this panel is not
56    #  tied to any perspective
57    ALWAYS_ON = True
58    ## Group ID
59    group_id = None
60   
61    def __init__(self, parent, id=-1, color = None,
62                 dpi=None, style=wx.NO_FULL_REPAINT_ON_RESIZE, **kwargs):
63        PlotPanel.__init__(self, parent, id=id, style=style, **kwargs)
64        PanelBase.__init__(self, parent)
65        ## Reference to the parent window
66        self.parent = parent
67        ## Plottables
68        self.plots = {}
69        #context menu
70        self._slicerpop = None
71       
72        self._available_data = []
73        self._menu_add_ids = []
74        self._symbol_labels = self.get_symbol_label()
75        self._color_labels = self.get_color_label()
76        self.currColorIndex = ""
77        self._is_changed_legend_label = False
78     
79        self.hide_menu = None
80        ## Unique ID (from gui_manager)
81        self.uid = None
82        self.x_size = None
83        ## Default locations
84        #self._default_save_location = os.getcwd()
85        self.size = None       
86        ## Graph       
87        #self.graph = Graph()
88        self.graph.xaxis("\\rm{Q}", 'A^{-1}')
89        self.graph.yaxis("\\rm{Intensity} ", "cm^{-1}")
90        self.graph.render(self)
91       
92        # In resizing event
93        self.resizing = False
94        self.canvas.set_resizing(self.resizing)
95        self.Bind(wx.EVT_SIZE, self._OnReSize)
96        self._add_more_tool()
97        self.parent.SetFocus()
98       
99       
100    def get_symbol_label(self):
101        """
102        Associates label to symbol
103        """
104        _labels = {}
105        i = 0
106        _labels['Circle'] = i
107        i += 1
108        _labels['Cross X '] = i
109        i += 1
110        _labels['Triangle Down'] = i
111        i += 1
112        _labels['Triangle Up'] = i
113        i += 1
114        _labels['Triangle Left'] = i
115        i += 1
116        _labels['Triangle Right'] = i
117        i += 1
118        _labels['Cross +'] = i
119        i += 1
120        _labels['Square'] = i
121        i += 1
122        _labels['Diamond'] = i
123        i += 1
124        _labels['Diamond'] = i
125        i += 1
126        _labels['Hexagon1'] = i
127        i += 1
128        _labels['Hexagon2'] = i
129        i += 1
130        _labels['Pentagon'] = i
131        i += 1
132        _labels['Line'] = i
133        return _labels
134   
135    def get_color_label(self):
136        """
137        Associates label to a specific color
138        """
139        _labels = {}
140        i = 0
141        _labels['Blue'] = i
142        i += 1
143        _labels['Green'] = i
144        i += 1
145        _labels['Red'] = i
146        i += 1
147        _labels['Cyan'] = i
148        i += 1
149        _labels['Magenta'] = i
150        i += 1
151        _labels['Yellow'] = i
152        i += 1
153        _labels['Black'] = i
154        return _labels
155
156   
157    def set_data(self, list=None):
158        """
159        """
160        pass
161   
162    def _reset(self):
163        """
164        Resets internal data and graph
165        """   
166        self.graph.reset()
167        self.plots      = {}
168        if self.is_zoomed:
169            self.is_zoomed = False
170       
171    def _OnReSize(self, event):   
172        """
173        On response of the resize of a panel, set axes_visiable False
174        """
175        # It was found that wx >= 2.9.3 sends an event even if no size changed.
176        # So manually recode the size (=x_size) and compare here.
177        # Massy code to work around:<
178        if self.parent._mgr != None:
179            max_panel = self.parent._mgr.GetPane(self)
180            if max_panel.IsMaximized():
181                self.parent._mgr.RestorePane(max_panel)
182                max_panel.Maximize()
183        if self.x_size != None:
184            if self.x_size == self.GetSize():
185                self.resizing = False
186                self.canvas.set_resizing(self.resizing)
187                return
188        self.x_size = self.GetSize()
189
190        # Ready for another event
191        # Do not remove this Skip. Otherwise it will get runtime error on wx>=2.9.
192        event.Skip() 
193        # set the resizing flag
194        self.resizing = True
195        self.canvas.set_resizing(self.resizing)
196        self.parent.set_schedule(True)
197        pos_x, pos_y = self.GetPositionTuple()
198        if pos_x != 0 and pos_y != 0:
199            self.size, _ = self.GetClientSizeTuple()
200        self.SetSizer(self.sizer)
201        wx.CallAfter(self.parent.disable_app_menu,self)
202       
203    def set_resizing(self, resizing=False):
204        """
205        Set the resizing (True/False)
206        """
207        self.resizing = resizing
208        #self.canvas.set_resizing(resizing)
209   
210    def schedule_full_draw(self, func='append'):   
211        """
212        Put self in schedule to full redraw list
213        """
214        # append/del this panel in the schedule list
215        self.parent.set_schedule_full_draw(self, func)
216       
217
218    def remove_data_by_id(self, id):
219        """'
220        remove data from plot
221        """
222        if id in self.plots.keys():
223            data =  self.plots[id]
224            self.graph.delete(data)
225            data_manager = self._manager.parent.get_data_manager()
226            data_list, theory_list = data_manager.get_by_id(id_list=[id])
227           
228            if id in data_list.keys():
229                data = data_list[id]
230            if id in theory_list.keys():
231                data = theory_list[id]
232            # Update Graph menu and help string       
233            h_id = self.parent._window_menu.FindItem(self.window_caption)
234            if data != None:
235                if data.__class__.__name__ == 'list':
236                    label = data[0].label
237                else:
238                    label = data.label
239            else:
240                label = '???'
241            helpString = self.parent._window_menu.GetHelpString(h_id) 
242            d_string = (' ' + str(label) +';')
243            new_tip = helpString.replace(d_string, '')
244            self.parent._window_menu.SetHelpString(h_id, new_tip) 
245
246            del self.plots[id]
247            self.graph.render(self)
248            self.subplot.figure.canvas.draw_idle()   
249            if len(self.graph.plottables) == 0:
250                #onRemove: graph is empty must be the panel must be destroyed
251                self.parent.delete_panel(self.uid)
252           
253       
254    def plot_data(self, data):
255        """
256        Data is ready to be displayed
257       
258        :param event: data event
259        """
260        if data.__class__.__name__ == 'Data2D':
261            return
262        if data.id in self.plots.keys():
263            #Recover panel prop.s
264            xlo, xhi = self.subplot.get_xlim()
265            ylo, yhi = self.subplot.get_ylim()
266            old_data = self.plots[data.id]
267            if self._is_changed_legend_label:
268                data.label = old_data.label
269            if old_data.__class__.__name__ == 'Data1D':
270                data.custom_color = old_data.custom_color
271                data.symbol = old_data.symbol
272                data.markersize = old_data.markersize
273            # Replace data
274            self.graph.replace(data)
275            self.plots[data.id] = data
276            ## Set the view scale for all plots
277            try:
278                self._onEVT_FUNC_PROPERTY()
279            except:
280                msg=" Encountered singular points..."
281                wx.PostEvent(self.parent, StatusEvent(status=\
282                    "Plotting Error: %s"% msg, info="error")) 
283            # Check if zoomed
284            toolbar_zoomed = self.toolbar.GetToolEnabled(self.toolbar._NTB2_BACK)
285            if self.is_zoomed or toolbar_zoomed:
286                # Recover the x,y limits
287                self.subplot.set_xlim((xlo, xhi))     
288                self.subplot.set_ylim((ylo, yhi)) 
289        else:
290            self.plots[data.id] = data
291            self.graph.add(self.plots[data.id]) 
292            ## Set the view scale for all plots
293            try:
294                self._onEVT_FUNC_PROPERTY()
295                if IS_MAC:
296                    # MAC: forcing to plot 2D avg
297                    self.canvas._onDrawIdle()
298            except:
299                msg=" Encountered singular points..."
300                wx.PostEvent(self.parent, StatusEvent(status=\
301                    "Plotting Error: %s"% msg, info="error")) 
302            self.toolbar.update()
303            if self.is_zoomed:
304                self.is_zoomed = False
305            # Update Graph menu and help string       
306            pos = self.parent._window_menu.FindItem(self.window_caption)
307            helpString = 'Show/Hide Graph: '
308            for plot in  self.plots.itervalues():
309                helpString += (' ' + str(plot.label) +';')
310            self.parent._window_menu.SetHelpString(pos, helpString)     
311         
312    def draw_plot(self):
313        """
314        Draw plot
315        """
316        self.draw() 
317
318    def onLeftDown(self,event): 
319        """
320        left button down and ready to drag
321        Display the position of the mouse on the statusbar
322        """
323        PlotPanel.onLeftDown(self, event)
324        ax = event.inaxes
325        if ax != None:
326            try:
327                pos_x = float(event.xdata)# / size_x
328                pos_y = float(event.ydata)# / size_y
329                pos_x = "%8.3g"% pos_x
330                pos_y = "%8.3g"% pos_y
331                self.position = str(pos_x), str(pos_y)
332                wx.PostEvent(self.parent, StatusEvent(status=self.position))
333            except:
334                self.position = None 
335        # unfocus all
336        self.parent.set_plot_unfocus() 
337        #post nd event to notify guiframe that this panel is on focus
338        wx.PostEvent(self.parent, PanelOnFocusEvent(panel=self))
339
340       
341    def _ontoggle_hide_error(self, event):
342        """
343        Toggle error display to hide or show
344        """
345        menu = event.GetEventObject()
346        id = event.GetId()
347        self.set_selected_from_menu(menu, id)
348        # Check zoom
349        xlo, xhi = self.subplot.get_xlim()
350        ylo, yhi = self.subplot.get_ylim()
351
352        selected_plot = self.plots[self.graph.selected_plottable]
353        if self.hide_menu.GetText() == "Hide Error Bar":
354            selected_plot.hide_error = True
355        else:
356            selected_plot.hide_error = False
357        ## increment graph color
358        self.graph.render(self)
359        self.subplot.figure.canvas.draw_idle() 
360        # Check if zoomed
361        toolbar_zoomed = self.toolbar.GetToolEnabled(self.toolbar._NTB2_BACK)
362        if self.is_zoomed or toolbar_zoomed:
363            # Recover the x,y limits
364            self.subplot.set_xlim((xlo, xhi))     
365            self.subplot.set_ylim((ylo, yhi)) 
366
367         
368    def _onRemove(self, event):
369        """
370        Remove a plottable from the graph and render the graph
371       
372        :param event: Menu event
373       
374        """
375        menu = event.GetEventObject()
376        id = event.GetId()
377        self.set_selected_from_menu(menu, id)
378        ## Check if there is a selected graph to remove
379        if self.graph.selected_plottable in self.plots.keys():
380            selected_plot = self.plots[self.graph.selected_plottable]
381            id = self.graph.selected_plottable
382            self.remove_data_by_id(id)
383           
384    def onContextMenu(self, event):
385        """
386        1D plot context menu
387       
388        :param event: wx context event
389       
390        """
391        self._slicerpop = PanelMenu()
392        self._slicerpop.set_plots(self.plots)
393        self._slicerpop.set_graph(self.graph)   
394        if not self.graph.selected_plottable in self.plots: 
395            # Various plot options
396            id = wx.NewId()
397            self._slicerpop.Append(id, '&Save Image', 'Save image as PNG')
398            wx.EVT_MENU(self, id, self.onSaveImage)
399            id = wx.NewId()
400            self._slicerpop.Append(id, '&Print Image', 'Print image ')
401            wx.EVT_MENU(self, id, self.onPrint)
402            id = wx.NewId()
403            self._slicerpop.Append(id, '&Print Preview', 'Print preview')
404            wx.EVT_MENU(self, id, self.onPrinterPreview)
405           
406            id = wx.NewId()
407            self._slicerpop.Append(id, '&Copy to Clipboard', 'Copy to the clipboard')
408            wx.EVT_MENU(self, id, self.OnCopyFigureMenu)
409                   
410            self._slicerpop.AppendSeparator()
411
412        for plot in self.plots.values():
413            #title = plot.title
414            name = plot.name
415            plot_menu = wx.Menu()
416            if self.graph.selected_plottable:
417                if not self.graph.selected_plottable in self.plots.keys():
418                    continue
419                if plot != self.plots[self.graph.selected_plottable]:
420                    continue
421               
422            id = wx.NewId()
423            plot_menu.Append(id, "&DataInfo", name)
424            wx.EVT_MENU(self, id, self. _onDataShow)
425            id = wx.NewId()
426            plot_menu.Append(id, "&Save Points as a File", name)
427            wx.EVT_MENU(self, id, self._onSave)
428            plot_menu.AppendSeparator()
429           
430            #add menu of other plugins
431            item_list = self.parent.get_current_context_menu(self)
432             
433            if (not item_list == None) and (not len(item_list) == 0):
434                for item in item_list:
435
436                    try:
437                        id = wx.NewId()
438                        plot_menu.Append(id, item[0], name)
439                        wx.EVT_MENU(self, id, item[2])
440                    except:
441                        msg = "ModelPanel1D.onContextMenu: "
442                        msg += "bad menu item  %s" % sys.exc_value
443                        wx.PostEvent(self.parent, StatusEvent(status=msg))
444                        pass
445                plot_menu.AppendSeparator()
446           
447            if self.parent.ClassName.count('wxDialog') == 0: 
448                id = wx.NewId()
449                plot_menu.Append(id, '&Linear Fit', name)
450                wx.EVT_MENU(self, id, self.onFitting)
451                plot_menu.AppendSeparator()
452   
453                id = wx.NewId()
454                plot_menu.Append(id, "Remove", name)
455                wx.EVT_MENU(self, id, self._onRemove)
456                if not plot.is_data:
457                    id = wx.NewId()
458                    plot_menu.Append(id, '&Freeze', name)
459                    wx.EVT_MENU(self, id, self.onFreeze)
460                plot_menu.AppendSeparator()   
461                symbol_menu = wx.Menu()
462               
463                if plot.is_data:
464                    id = wx.NewId()
465                    self.hide_menu = plot_menu.Append(id, 
466                                                    "Hide Error Bar", name)
467       
468                    if plot.dy is not None and plot.dy != []:
469                        if plot.hide_error :
470                            self.hide_menu.SetText('Show Error Bar')
471                        else:
472                            self.hide_menu.SetText('Hide Error Bar')
473                    else:
474                        self.hide_menu.Enable(False)
475                    wx.EVT_MENU(self, id, self._ontoggle_hide_error)
476               
477                    plot_menu.AppendSeparator()
478
479                id = wx.NewId()
480                plot_menu.Append(id, '&Modify graph properties', name)
481                wx.EVT_MENU(self, id, self.createAppDialog)
482
483
484
485            id = wx.NewId()
486            #plot_menu.SetTitle(name)
487            self._slicerpop.AppendMenu(id, '&%s'% name, plot_menu)
488                # Option to hide
489                #TODO: implement functionality to hide a plottable (legend click)
490        if not self.graph.selected_plottable in self.plots: 
491            self._slicerpop.AppendSeparator()
492            loc_menu = wx.Menu()
493            for label in self._loc_labels:
494                id = wx.NewId()
495                loc_menu.Append(id, str(label), str(label))
496                wx.EVT_MENU(self, id, self.onChangeLegendLoc)
497            id = wx.NewId()
498            self._slicerpop.AppendMenu(id, '&Modify Legend Location', loc_menu)
499           
500            id = wx.NewId()
501            self._slicerpop.Append(id, '&Toggle Legend On/Off', 'Toggle Legend On/Off')
502            wx.EVT_MENU(self, id, self.onLegend)
503            self._slicerpop.AppendSeparator()
504           
505            id = wx.NewId()
506            self._slicerpop.Append(id, '&Edit Y Axis Label')
507            wx.EVT_MENU(self, id, self._on_yaxis_label)     
508            id = wx.NewId()
509            self._slicerpop.Append(id, '&Edit X Axis Label')
510            wx.EVT_MENU(self, id, self._on_xaxis_label)
511   
512            id = wx.NewId()
513            self._slicerpop.Append(id, '&Toggle Grid On/Off', 'Toggle Grid On/Off')
514            wx.EVT_MENU(self, id, self.onGridOnOff)
515            self._slicerpop.AppendSeparator()
516           
517            if self.position != None:
518                id = wx.NewId()
519                self._slicerpop.Append(id, '&Add Text')
520                wx.EVT_MENU(self, id, self._on_addtext)
521                id = wx.NewId()
522                self._slicerpop.Append(id, '&Remove Text')
523                wx.EVT_MENU(self, id, self._on_removetext)
524                self._slicerpop.AppendSeparator()
525            id = wx.NewId()
526            self._slicerpop.Append(id, '&Change Scale')
527            wx.EVT_MENU(self, id, self._onProperties)
528            self._slicerpop.AppendSeparator()
529            id = wx.NewId()
530            self._slicerpop.Append(id, '&Reset Graph Range')
531            wx.EVT_MENU(self, id, self.onResetGraph) 
532           
533            if self.parent.ClassName.count('wxDialog') == 0:   
534                self._slicerpop.AppendSeparator()
535                id = wx.NewId()
536                self._slicerpop.Append(id, '&Window Title')
537                wx.EVT_MENU(self, id, self.onChangeCaption)
538        try:
539            pos_evt = event.GetPosition()
540            pos = self.ScreenToClient(pos_evt)
541        except:
542            pos_x, pos_y = self.toolbar.GetPositionTuple()
543            pos = (pos_x, pos_y + 5)
544        self.PopupMenu(self._slicerpop, pos)
545           
546    def onFreeze(self, event):
547        """
548        """
549        menu = event.GetEventObject()
550        id = event.GetId()
551        self.set_selected_from_menu(menu, id)
552        plot = self.plots[self.graph.selected_plottable]
553        self.parent.onfreeze([plot.id])
554       
555                       
556    def _onSave(self, evt):
557        """
558        Save a data set to a text file
559       
560        :param evt: Menu event
561       
562        """
563        menu = evt.GetEventObject()
564        id = evt.GetId()
565        self.set_selected_from_menu(menu, id)
566        data = self.plots[self.graph.selected_plottable]
567        default_name = data.label
568        if default_name.count('.') > 0:
569            default_name = default_name.split('.')[0]
570        default_name += "_out"
571        if self.parent != None:
572            self.parent.save_data1d(data, default_name)
573
574                       
575    def _onDataShow(self, evt):
576        """
577        Show the data set in text
578       
579        :param evt: Menu event
580       
581        """
582        menu = evt.GetEventObject()
583        id = evt.GetId()
584        self.set_selected_from_menu(menu, id)
585        data = self.plots[self.graph.selected_plottable]
586        default_name = data.label
587        if default_name.count('.') > 0:
588            default_name = default_name.split('.')[0]
589        #default_name += "_out"
590        if self.parent != None:
591            self.parent.show_data1d(data, default_name)
592           
593    def _add_more_tool(self):
594        """
595        Add refresh, add/hide button in the tool bar
596        """
597        if self.parent.__class__.__name__ != 'ViewerFrame':
598            return
599        self.toolbar.AddSeparator()
600        id_hide = wx.NewId()
601        hide = wx.Bitmap(GUIFRAME_ICON.HIDE_ID_PATH, wx.BITMAP_TYPE_PNG)
602        self.toolbar.AddSimpleTool(id_hide, hide, 'Hide', 'Hide')
603        self.toolbar.Realize()
604        wx.EVT_TOOL(self, id_hide,  self._on_hide)
605       
606    def _on_hide(self, event):
607        """
608        Hides the plot when button is pressed
609        """     
610        if self.parent is not None:
611            self.parent.hide_panel(self.uid)
612
613    def createAppDialog(self, event):
614        """
615        Create the custom dialog for fit appearance modification
616        """
617        menu = event.GetEventObject()
618        id = event.GetId()
619        self.set_selected_from_menu(menu,id)
620        self.appearance_selected_plot = self.plots[self.graph.selected_plottable]
621
622        # find current properties
623        curr_color = self.appearance_selected_plot.custom_color
624        curr_symbol = self.appearance_selected_plot.symbol
625        curr_size = self.appearance_selected_plot.markersize
626        curr_label = self.appearance_selected_plot.label
627
628        if curr_color == None:
629            curr_color = self._color_labels['Blue']
630            curr_symbol = 13
631
632        self.appD = appearanceDialog(self,'Modify graph properties')
633        self.appD.setDefaults(float(curr_size),int(curr_color),str(appearanceDialog.find_key(self.get_symbol_label(),int(curr_symbol))),curr_label)
634        self.appD.Bind(wx.EVT_CLOSE, self.on_AppDialog_close)   
635
636    def on_AppDialog_close(self,e):
637        if(self.appD.okay_clicked == True):
638            info = self.appD.getCurrentValues() # returns (size,color,symbol,datalabel)
639            self.appearance_selected_plot.custom_color = self._color_labels[info[1].encode('ascii','ignore')]
640
641            self.appearance_selected_plot.markersize = float(info[0])
642            self.appearance_selected_plot.symbol = self.get_symbol_label()[info[2]] # self._symbol_labels[info[2].encode('ascii','ignore')]
643            self.appearance_selected_plot.label = str(info[3])
644
645            pos = self.parent._window_menu.FindItem(self.window_caption)
646            helpString = 'Show/Hide Graph: '
647            for plot in  self.plots.itervalues():
648                helpString += (' ' + str(plot.label) +';')
649                self.parent._window_menu.SetHelpString(pos, helpString)
650                self._is_changed_legend_label = True
651               
652        self.appD.Destroy()
653        self._check_zoom_plot()
Note: See TracBrowser for help on using the repository browser.