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

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 cdf515f was cdf515f, checked in by Jae Cho <jhjcho@…>, 12 years ago

Bug fix: clean up plot_panel(guimanager) dic on deleting data
  • Property mode set to 100644
File size: 12.9 KB
Line 
1
2
3
4################################################################################
5#This software was developed by the University of Tennessee as part of the
6#Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
7#project funded by the US National Science Foundation.
8#
9#See the license text in license.txt
10#
11#copyright 2008, University of Tennessee
12################################################################################
13
14import wx
15import sys
16from sans.guiframe.events import EVT_NEW_PLOT
17from sans.guiframe.events import StatusEvent
18from sans.guiframe.events import DeletePlotPanelEvent
19from sans.guiframe.plugin_base import PluginBase
20from sans.guiframe.dataFitting import Data1D
21from sans.guiframe.dataFitting import Data2D
22
23DEFAULT_MENU_ITEM_LABEL = "No graph available"
24DEFAULT_MENU_ITEM_ID = wx.NewId()
25
26IS_WIN = True   
27if sys.platform.count("win32")==0:
28    if int(wx.__version__.split('.')[0]) == 2:
29        if int(wx.__version__.split('.')[1]) < 9:
30            IS_WIN = False
31
32
33class Plugin(PluginBase):
34    """
35    Plug-in class to be instantiated by the GUI manager
36    """
37   
38    def __init__(self, standalone=False):
39        PluginBase.__init__(self, name="Plotting", standalone=standalone)
40     
41        ## Plot panels
42        self.plot_panels = {}
43        self._panel_on_focus = None
44        self.menu_default_id = None
45        # Plot menu
46        self.menu = None
47
48     
49    def set_panel_on_focus(self, panel):
50        """
51        """
52        self._panel_on_focus = panel
53       
54    def is_always_active(self):
55        """
56        return True is this plugin is always active even if the user is
57        switching between perspectives
58        """
59        return True
60   
61    def populate_menu(self, parent):
62        """
63        Create a 'Plot' menu to list the panels
64        available for displaying
65       
66        :param id: next available unique ID for wx events
67        :param parent: parent window
68       
69        """
70        self.menu = wx.Menu()
71        self.menu.Append(DEFAULT_MENU_ITEM_ID, DEFAULT_MENU_ITEM_LABEL, 
72                             "No graph available")
73        self.menu.FindItemByPosition(0).Enable(False)
74        return [(self.menu, "Show")]
75   
76    def get_panels(self, parent):
77        """
78        Create and return a list of panel objects
79        """
80        ## Save a reference to the parent
81        self.parent = parent
82        # Connect to plotting events
83        self.parent.Bind(EVT_NEW_PLOT, self._on_plot_event)
84        # We have no initial panels for this plug-in
85        return []
86   
87    def _on_show_panel(self, event):
88        """show plug-in panel"""
89        pass
90   
91    def remove_plot(self, group_id, id):
92        """
93        remove plot of ID = id from a panel of group ID =group_id
94        """
95       
96        if group_id in self.plot_panels.keys():
97            panel = self.plot_panels[group_id]
98            panel.remove_data_by_id(id=id)
99           
100            return True
101        return False
102       
103    def clear_panel(self):
104        """
105        Clear and Hide all plot panels, and remove them from menu
106        """
107        for group_id in self.plot_panels.keys():
108            panel = self.plot_panels[group_id]
109            panel.graph.reset()
110            self.hide_panel(group_id)
111        self.plot_panels = {}
112        item = self.menu.FindItemByPosition(0)
113        while item != None:
114            self.menu.DeleteItem(item) 
115            try:
116                item = self.menu.FindItemByPosition(0)
117            except:
118                item = None
119               
120   
121    def clear_panel_by_id(self, group_id):
122        """
123        clear the graph
124        """
125        if group_id in self.plot_panels.keys():
126            panel = self.plot_panels[group_id]
127            for plottable in panel.graph.plottables.keys():
128                self.remove_plot(group_id, plottable.id)
129            panel.graph.reset()
130            return True
131        return False
132           
133    def hide_panel(self, group_id):
134        """
135        hide panel with group ID = group_id
136        """
137        if group_id in self.plot_panels.keys():
138            panel = self.plot_panels[group_id]
139            self.parent.hide_panel(panel.uid)
140            return True
141        return False
142   
143    def create_panel_helper(self, new_panel, data, group_id, title=None):
144        """
145        """
146         ## Set group ID if available
147        ## Assign data properties to the new create panel
148        new_panel.set_manager(self)
149        new_panel.group_id = group_id
150        if group_id not in data.list_group_id:
151            data.list_group_id.append(group_id)
152        if title is None:
153            title = data.title
154        new_panel.window_caption = title
155        new_panel.window_name = data.title
156        event_id = self.parent.popup_panel(new_panel)
157        #remove the default item in the menu
158        if len(self.plot_panels) == 0:
159            pos = self.menu.FindItem(DEFAULT_MENU_ITEM_LABEL)
160            if pos != -1:
161                self.menu.Delete(DEFAULT_MENU_ITEM_ID)
162        # Set UID to allow us to reference the panel later
163        new_panel.uid = event_id
164        # Ship the plottable to its panel
165        wx.CallAfter(new_panel.plot_data, data) 
166        self.plot_panels[new_panel.group_id] = new_panel
167       
168        # Set Graph menu and help string       
169        helpString = 'Show/Hide Graph: '
170        for plot in  new_panel.plots.itervalues():
171            helpString += (' ' + plot.label + ';')
172        self.menu.AppendCheckItem(event_id, new_panel.window_caption, 
173                                  helpString)
174        self.menu.Check(event_id, IS_WIN)
175        wx.EVT_MENU(self.parent, event_id, self._on_check_menu)
176
177        wx.EVT_SHOW(new_panel, self._on_close_panel)
178
179       
180    def create_1d_panel(self, data, group_id):
181        """
182        """
183        # Create a new plot panel if none was available       
184        if issubclass(data.__class__, Data1D):
185            from Plotter1D import ModelPanel1D
186            ## get the data representation label of the data to plot
187            ## when even the user select "change scale"
188            xtransform = data.xtransform
189            ytransform = data.ytransform
190            ## create a plotpanel for 1D Data
191            new_panel = ModelPanel1D(self.parent, -1, xtransform=xtransform,
192                     ytransform=ytransform, style=wx.RAISED_BORDER)
193            return  new_panel
194       
195        msg = "1D Panel of group ID %s could not be created" % str(group_id)
196        raise ValueError, msg
197   
198    def create_2d_panel(self, data, group_id):
199        """
200        """
201        if issubclass(data.__class__, Data2D):
202            ##Create a new plotpanel for 2D data
203            from Plotter2D import ModelPanel2D
204            scale = data.scale
205            new_panel = ModelPanel2D(self.parent, id = -1,
206                                data2d=data, scale = scale, 
207                                style=wx.RAISED_BORDER)
208            return new_panel
209        msg = "2D Panel of group ID %s could not be created" % str(group_id)
210        raise ValueError, msg
211   
212    def update_panel(self, data, panel):
213        """
214        update the graph of a given panel
215        """
216        # Check whether we already have a graph with the same units
217        # as the plottable we just received.
218        _, x_unit =  data.get_xaxis()
219        _, y_unit =  data.get_yaxis()
220        flag_x = (panel.graph.prop["xunit"] is not None) and \
221                    (panel.graph.prop["xunit"].strip() != "") and\
222                    (x_unit != panel.graph.prop["xunit"]) and False
223        flag_y = (panel.graph.prop["yunit"] is not None) and \
224                    (panel.graph.prop["yunit"].strip() != "") and\
225                    (y_unit != panel.graph.prop["yunit"]) and False
226        if (flag_x and flag_y):
227            msg = "Cannot add %s" % str(data.name)
228            msg += " to panel %s\n" % str(panel.window_caption)
229            msg += "Please edit %s's units, labels" % str(data.name)
230            raise ValueError, msg
231        else:
232            if panel.group_id not in data.list_group_id:
233                data.list_group_id.append(panel.group_id)
234            wx.CallAfter(panel.plot_data, data)
235            self.parent.show_panel(panel.uid)   
236   
237    def delete_menu_item(self, name, uid):
238        """
239        """
240        #remove menu item
241        pos = self.menu.FindItem(name) 
242        if pos != -1:
243            self.menu.Delete(uid)
244        if self.menu.GetMenuItemCount() == 0:
245            self.menu.Append(DEFAULT_MENU_ITEM_ID, DEFAULT_MENU_ITEM_LABEL, 
246                             "No graph available")
247            self.menu.FindItemByPosition(0).Enable(False)
248       
249    def delete_panel(self, group_id):
250        """
251        """
252        if group_id in self.plot_panels.keys():
253            panel = self.plot_panels[group_id]
254            uid = panel.uid
255            wx.PostEvent(self.parent, 
256                         DeletePlotPanelEvent(name=panel.window_caption,
257                                    caption=panel.window_caption))
258            #remove menu item
259            self.delete_menu_item(panel.window_caption, panel.uid)
260            del self.plot_panels[group_id]
261            if uid in self.parent.plot_panels.keys():
262                del self.parent.plot_panels[uid]
263            return True
264
265        return False
266   
267    def _on_plot_event(self, event):
268        """
269        A new plottable is being shipped to the plotting plug-in.
270        Check whether we have a panel to put in on, or create
271        a new one
272       
273        :param event: EVT_NEW_PLOT event
274       
275        """
276        if hasattr(event, 'action'):
277            group_id = event.group_id
278            if group_id in self.plot_panels.keys():
279                #remove data from panel
280                if event.action.lower().strip() == 'remove':
281                    id = event.id
282                    return self.remove_plot(group_id, id)
283                if event.action.lower().strip() == 'hide':
284                    return self.hide_panel(group_id)
285                if event.action.lower().strip() == 'delete':
286                    panel = self.plot_panels[group_id]
287                    uid = panel.uid
288                    return self.parent.delete_panel(uid)
289                if event.action.lower().strip() == "clear":
290                    return self.clear_panel_by_id(group_id)
291        if not hasattr(event, 'plot'):   
292            return
293        title = None
294        if hasattr(event, 'title'):
295            title = 'Graph'#event.title
296               
297        data = event.plot
298        group_id = data.group_id
299           
300        if group_id in self.plot_panels.keys():
301            #update a panel graph
302            panel = self.plot_panels[group_id]
303            self.update_panel(data, panel)
304        else:
305            #create a new panel
306            if issubclass(data.__class__, Data1D):
307                new_panel = self.create_1d_panel(data, group_id)
308            else:
309                new_panel = self.create_2d_panel(data, group_id)
310            self.create_panel_helper(new_panel, data, group_id, title)
311     
312        return
313
314    def _on_check_menu(self, event):
315        """
316        Check mark on menu
317        """
318        #event.Skip()
319        event_id = event.GetId()
320
321        if self.menu.IsChecked(event_id):
322            self.parent.on_view(event)
323            self.menu.Check(event_id, IS_WIN)
324        else:
325            self.parent.hide_panel(event_id)
326            self.menu.Check(event_id, False)
327       
328    def help(self, evt):
329        """
330        Show a general help dialog.
331        """
332        from help_panel import  HelpWindow
333        frame = HelpWindow(None, -1) 
334        if hasattr(frame, "IsIconized"):
335            if not frame.IsIconized():
336                try:
337                    icon = self.parent.GetIcon()
338                    frame.SetIcon(icon)
339                except:
340                    pass 
341        frame.Show(True)
342             
343    def _on_close_panel(self, event):
344        """
345        Update check mark on panel's show and hide event
346        """
347        event.Skip()
348        panel = event.GetEventObject()
349        id = panel.uid
350        if event.GetShow() and self.parent._mgr.GetPane(panel).IsShown():
351            try:
352                if self.menu.FindItemById(id) != None:
353                    if not self.menu.IsChecked(id):
354                        self.menu.Check(id, True)
355                        #self.menu.Enable(id, False)
356            except:
357                # when no such item; may happens after delete
358                pass
359        else:
360            try:
361                if self.menu.FindItemById(id) != None:
362                    if self.menu.IsChecked(id):
363                        self.menu.Check(id, False)
364                        #self.menu.Enable(id, True)
365            except:
366                pass 
Note: See TracBrowser for help on using the repository browser.