source: sasview/guiframe/local_perspectives/plotting/plotting.py @ df8a13e

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

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