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

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 4c2c93f was c572e5e, checked in by Jae Cho <jhjcho@…>, 13 years ago

minor fix: remove plot id in panels dic of guiframe when the panel removed
  • Property mode set to 100644
File size: 12.3 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            panel.graph.reset()
128            return True
129        return False
130           
131       
132    def hide_panel(self, group_id):
133        """
134        hide panel with group ID = group_id
135        """
136        if group_id in self.plot_panels.keys():
137            panel = self.plot_panels[group_id]
138            self.parent.hide_panel(panel.uid)
139            return True
140        return False
141   
142    def create_panel_helper(self, new_panel, data, group_id, title=None):
143        """
144        """
145         ## Set group ID if available
146        ## Assign data properties to the new create panel
147        new_panel.set_manager(self)
148        new_panel.group_id = group_id
149        if group_id not in data.list_group_id:
150            data.list_group_id.append(group_id)
151        if title is None:
152            title = data.title
153        new_panel.window_caption = title
154        new_panel.window_name = data.title
155        event_id = self.parent.popup_panel(new_panel)
156        #remove the default item in the menu
157        if len(self.plot_panels) == 0:
158            pos = self.menu.FindItem(DEFAULT_MENU_ITEM_LABEL)
159            if pos != -1:
160                self.menu.Delete(DEFAULT_MENU_ITEM_ID)
161        # Set UID to allow us to reference the panel later
162        new_panel.uid = event_id
163        # Ship the plottable to its panel
164        new_panel.plot_data(data) 
165        self.plot_panels[new_panel.group_id] = new_panel
166       
167        # Set Graph menu and help string       
168        helpString = 'Show/Hide Graph: '
169        for plot in  new_panel.plots.itervalues():
170            helpString += (' ' + plot.label + ';')
171        self.menu.AppendCheckItem(event_id, new_panel.window_caption, 
172                                  helpString)
173        self.menu.Check(event_id, IS_WIN)
174        wx.EVT_MENU(self.parent, event_id, self._on_check_menu)
175
176        wx.EVT_SHOW(new_panel, self._on_close_panel)
177
178       
179    def create_1d_panel(self, data, group_id):
180        """
181        """
182        # Create a new plot panel if none was available       
183        if issubclass(data.__class__, Data1D):
184            from Plotter1D import ModelPanel1D
185            ## get the data representation label of the data to plot
186            ## when even the user select "change scale"
187            xtransform = data.xtransform
188            ytransform = data.ytransform
189            ## create a plotpanel for 1D Data
190            new_panel = ModelPanel1D(self.parent, -1, xtransform=xtransform,
191                     ytransform=ytransform, style=wx.RAISED_BORDER)
192            return  new_panel
193       
194        msg = "1D Panel of group ID %s could not be created" % str(group_id)
195        raise ValueError, msg
196   
197    def create_2d_panel(self, data, group_id):
198        """
199        """
200        if issubclass(data.__class__, Data2D):
201            ##Create a new plotpanel for 2D data
202            from Plotter2D import ModelPanel2D
203            scale = data.scale
204            new_panel = ModelPanel2D(self.parent, id = -1,
205                                data2d=data, scale = scale, 
206                                style=wx.RAISED_BORDER)
207            return new_panel
208        msg = "2D Panel of group ID %s could not be created" % str(group_id)
209        raise ValueError, msg
210   
211    def update_panel(self, data, panel):
212        """
213        update the graph of a given panel
214        """
215        # Check whether we already have a graph with the same units
216        # as the plottable we just received.
217        _, x_unit =  data.get_xaxis()
218        _, y_unit =  data.get_yaxis()
219        flag_x = (panel.graph.prop["xunit"] is not None) and \
220                    (panel.graph.prop["xunit"].strip() != "") and\
221                    (x_unit != panel.graph.prop["xunit"])
222        flag_y = (panel.graph.prop["yunit"] is not None) and \
223                    (panel.graph.prop["yunit"].strip() != "") and\
224                    (y_unit != panel.graph.prop["yunit"])
225        if (flag_x and flag_y):
226            msg = "Cannot add %s" % str(data.name)
227            msg += " to panel %s\n" % str(panel.window_caption)
228            msg += "Please edit %s's units, labels" % str(data.name)
229            raise ValueError, msg
230        else:
231            if panel.group_id not in data.list_group_id:
232                data.list_group_id.append(panel.group_id)
233            panel.plot_data( data)
234            self.parent.show_panel(panel.uid)   
235   
236    def delete_menu_item(self, name, uid):
237        """
238        """
239        #remove menu item
240        pos = self.menu.FindItem(name) 
241        if pos != -1:
242            self.menu.Delete(uid)
243        if self.menu.GetMenuItemCount() == 0:
244            self.menu.Append(DEFAULT_MENU_ITEM_ID, DEFAULT_MENU_ITEM_LABEL, 
245                             "No graph available")
246            self.menu.FindItemByPosition(0).Enable(False)
247       
248    def delete_panel(self, group_id):
249        """
250        """
251        if group_id in self.plot_panels.keys():
252            panel = self.plot_panels[group_id]
253            uid = panel.uid
254            wx.PostEvent(self.parent, 
255                         DeletePlotPanelEvent(name=panel.window_caption,
256                                    caption=panel.window_caption))
257            #remove menu item
258            self.delete_menu_item(panel.window_caption, panel.uid)
259            del self.plot_panels[group_id]
260            return True
261
262        return False
263   
264    def _on_plot_event(self, event):
265        """
266        A new plottable is being shipped to the plotting plug-in.
267        Check whether we have a panel to put in on, or create
268        a new one
269       
270        :param event: EVT_NEW_PLOT event
271       
272        """
273        if hasattr(event, 'action'):
274            group_id = event.group_id
275            #remove data from panel
276            if event.action.lower() == 'remove':
277                id = event.id
278                return self.remove_plot(group_id, id)
279            if event.action.lower() == 'hide':
280                return self.hide_panel(group_id)
281            if event.action.lower() == 'delete':
282                panel = self.plot_panels[group_id]
283                uid = panel.uid
284                return self.parent.delete_panel(uid)
285            if event.action.lower() == "clear":
286                return self.clear_panel_by_id(group_id)
287           
288        title = None
289        if hasattr(event, 'title'):
290            title = 'Graph'#event.title
291               
292        data = event.plot
293        group_id = data.group_id
294           
295        if group_id in self.plot_panels.keys():
296            #update a panel graph
297            panel = self.plot_panels[group_id]
298            self.update_panel(data, panel)
299        else:
300            #create a new panel
301            if issubclass(data.__class__, Data1D):
302                new_panel = self.create_1d_panel(data, group_id)
303            else:
304                new_panel = self.create_2d_panel(data, group_id)
305            self.create_panel_helper(new_panel, data, group_id, title)
306     
307        return
308
309    def _on_check_menu(self, event):
310        """
311        Check mark on menu
312        """
313        #event.Skip()
314        event_id = event.GetId()
315
316        if self.menu.IsChecked(event_id):
317            self.parent.on_view(event)
318            self.menu.Check(event_id, IS_WIN)
319        else:
320            self.parent.hide_panel(event_id)
321            self.menu.Check(event_id, False)
322       
323    def help(self, evt):
324        """
325        Show a general help dialog.
326        """
327        from help_panel import  HelpWindow
328        frame = HelpWindow(None, -1, 'HelpWindow')   
329        frame.Show(True)
330             
331    def _on_close_panel(self, event):
332        """
333        Update check mark on panel's show and hide event
334        """
335        event.Skip()
336        panel = event.GetEventObject()
337        id = panel.uid
338        if event.GetShow() and self.parent._mgr.GetPane(panel).IsShown():
339            try:
340                if self.menu.FindItemById(id) != None:
341                    if not self.menu.IsChecked(id):
342                        self.menu.Check(id, True)
343                        #self.menu.Enable(id, False)
344            except:
345                # when no such item; may happens after delete
346                pass
347        else:
348            try:
349                if self.menu.FindItemById(id) != None:
350                    if self.menu.IsChecked(id):
351                        self.menu.Check(id, False)
352                        #self.menu.Enable(id, True)
353            except:
354                pass 
Note: See TracBrowser for help on using the repository browser.