[41d466f] | 1 | |
---|
| 2 | |
---|
| 3 | |
---|
[d955bf19] | 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 | ################################################################################ |
---|
[41d466f] | 13 | |
---|
| 14 | import wx |
---|
| 15 | import sys |
---|
[f444b20] | 16 | from sans.guiframe.events import EVT_NEW_PLOT |
---|
| 17 | from sans.guiframe.events import StatusEvent |
---|
[7f84e22] | 18 | from sans.guiframe.plugin_base import PluginBase |
---|
[a07e72f] | 19 | from sans.guiframe.dataFitting import Data1D |
---|
| 20 | from sans.guiframe.dataFitting import Data2D |
---|
[7764b41] | 21 | |
---|
[00b76931] | 22 | DEFAULT_MENU_ITEM_LABEL = "No plot available" |
---|
| 23 | DEFAULT_MENU_ITEM_ID = wx.NewId() |
---|
| 24 | |
---|
[7f84e22] | 25 | class Plugin(PluginBase): |
---|
[41d466f] | 26 | """ |
---|
[d955bf19] | 27 | Plug-in class to be instantiated by the GUI manager |
---|
[41d466f] | 28 | """ |
---|
| 29 | |
---|
[7f84e22] | 30 | def __init__(self, standalone=False): |
---|
| 31 | PluginBase.__init__(self, name="Plotting", standalone=standalone) |
---|
| 32 | |
---|
[41d466f] | 33 | ## Plot panels |
---|
[ae83ad3] | 34 | self.plot_panels = {} |
---|
[a07e72f] | 35 | self._panel_on_focus = None |
---|
[00b76931] | 36 | self.menu_default_id = None |
---|
[a07e72f] | 37 | |
---|
| 38 | def set_panel_on_focus(self, panel): |
---|
| 39 | """ |
---|
| 40 | """ |
---|
| 41 | self._panel_on_focus = panel |
---|
| 42 | |
---|
[b7c7a1c] | 43 | def is_always_active(self): |
---|
| 44 | """ |
---|
| 45 | return True is this plugin is always active even if the user is |
---|
| 46 | switching between perspectives |
---|
| 47 | """ |
---|
| 48 | return True |
---|
| 49 | |
---|
[bf4402c3] | 50 | def populate_menu(self, parent): |
---|
[41d466f] | 51 | """ |
---|
[d955bf19] | 52 | Create a 'Plot' menu to list the panels |
---|
| 53 | available for displaying |
---|
| 54 | |
---|
| 55 | :param id: next available unique ID for wx events |
---|
| 56 | :param parent: parent window |
---|
| 57 | |
---|
[41d466f] | 58 | """ |
---|
| 59 | self.menu = wx.Menu() |
---|
[00b76931] | 60 | self.menu.Append(DEFAULT_MENU_ITEM_ID, DEFAULT_MENU_ITEM_LABEL, |
---|
[2fc9243] | 61 | "No plot available") |
---|
| 62 | self.menu.FindItemByPosition(0).Enable(False) |
---|
[bf4402c3] | 63 | return [(self.menu, "Plot")] |
---|
[41d466f] | 64 | |
---|
| 65 | def get_panels(self, parent): |
---|
| 66 | """ |
---|
[d955bf19] | 67 | Create and return a list of panel objects |
---|
[41d466f] | 68 | """ |
---|
| 69 | ## Save a reference to the parent |
---|
| 70 | self.parent = parent |
---|
| 71 | # Connect to plotting events |
---|
| 72 | self.parent.Bind(EVT_NEW_PLOT, self._on_plot_event) |
---|
| 73 | # We have no initial panels for this plug-in |
---|
| 74 | return [] |
---|
[54cc36a] | 75 | |
---|
[41d466f] | 76 | def _on_show_panel(self, event): |
---|
[6c0568b] | 77 | """show plug-in panel""" |
---|
| 78 | pass |
---|
| 79 | |
---|
[ae83ad3] | 80 | def remove_plot(self, group_id, id): |
---|
| 81 | """ |
---|
| 82 | remove plot of ID = id from a panel of group ID =group_id |
---|
| 83 | """ |
---|
| 84 | |
---|
| 85 | if group_id in self.plot_panels.keys(): |
---|
| 86 | panel = self.plot_panels[group_id] |
---|
| 87 | panel.remove_data_by_id(id=id) |
---|
| 88 | return True |
---|
| 89 | else: |
---|
| 90 | msg = "Panel with GROUP_ID: %s cannot be located" % str(group_id) |
---|
| 91 | raise ValueError, msg |
---|
| 92 | |
---|
| 93 | def hide_panel(self, group_id): |
---|
| 94 | """ |
---|
| 95 | hide panel with group ID = group_id |
---|
| 96 | """ |
---|
| 97 | if group_id in self.plot_panels.keys(): |
---|
| 98 | panel = self.plot_panels[group_id] |
---|
| 99 | self.parent.hide_panel(panel.uid) |
---|
| 100 | return True |
---|
| 101 | return False |
---|
| 102 | |
---|
[2bdb52b] | 103 | def create_panel_helper(self, new_panel, data, group_id, title=None): |
---|
[ae83ad3] | 104 | """ |
---|
| 105 | """ |
---|
| 106 | ## Set group ID if available |
---|
| 107 | ## Assign data properties to the new create panel |
---|
| 108 | new_panel.set_manager(self) |
---|
| 109 | new_panel.group_id = group_id |
---|
[2bdb52b] | 110 | if title is None: |
---|
| 111 | title = data.title |
---|
[ae83ad3] | 112 | new_panel.window_caption = title |
---|
[2bdb52b] | 113 | new_panel.window_name = data.title |
---|
[ae83ad3] | 114 | event_id = self.parent.popup_panel(new_panel) |
---|
| 115 | #remove the default item in the menu |
---|
| 116 | if len(self.plot_panels) == 0: |
---|
[00b76931] | 117 | pos = self.menu.FindItem(DEFAULT_MENU_ITEM_LABEL) |
---|
| 118 | if pos != -1: |
---|
| 119 | self.menu.Delete(DEFAULT_MENU_ITEM_ID) |
---|
| 120 | |
---|
[ae83ad3] | 121 | self.menu.Append(event_id, new_panel.window_caption, |
---|
| 122 | "Show %s plot panel" % new_panel.window_caption) |
---|
| 123 | # Set UID to allow us to reference the panel later |
---|
| 124 | new_panel.uid = event_id |
---|
| 125 | # Ship the plottable to its panel |
---|
| 126 | new_panel.plot_data(data) |
---|
| 127 | self.plot_panels[new_panel.group_id] = new_panel |
---|
[00b76931] | 128 | |
---|
[ae83ad3] | 129 | |
---|
| 130 | def create_1d_panel(self, data, group_id): |
---|
| 131 | """ |
---|
| 132 | """ |
---|
| 133 | # Create a new plot panel if none was available |
---|
| 134 | if issubclass(data.__class__, Data1D): |
---|
| 135 | from Plotter1D import ModelPanel1D |
---|
| 136 | ## get the data representation label of the data to plot |
---|
| 137 | ## when even the user select "change scale" |
---|
| 138 | xtransform = data.xtransform |
---|
| 139 | ytransform = data.ytransform |
---|
| 140 | ## create a plotpanel for 1D Data |
---|
| 141 | new_panel = ModelPanel1D(self.parent, -1, xtransform=xtransform, |
---|
| 142 | ytransform=ytransform, style=wx.RAISED_BORDER) |
---|
| 143 | return new_panel |
---|
| 144 | |
---|
| 145 | msg = "1D Panel of group ID %s could not be created" % str(group_id) |
---|
| 146 | raise ValueError, msg |
---|
| 147 | |
---|
| 148 | def create_2d_panel(self, data, group_id): |
---|
| 149 | """ |
---|
| 150 | """ |
---|
| 151 | if issubclass(data.__class__, Data2D): |
---|
| 152 | ##Create a new plotpanel for 2D data |
---|
| 153 | from Plotter2D import ModelPanel2D |
---|
| 154 | scale = data.scale |
---|
| 155 | new_panel = ModelPanel2D(self.parent, id = -1, |
---|
| 156 | data2d=data, scale = scale, |
---|
| 157 | style=wx.RAISED_BORDER) |
---|
| 158 | return new_panel |
---|
| 159 | msg = "2D Panel of group ID %s could not be created" % str(group_id) |
---|
| 160 | raise ValueError, msg |
---|
| 161 | |
---|
| 162 | def update_panel(self, data, panel): |
---|
| 163 | """ |
---|
| 164 | update the graph of a given panel |
---|
| 165 | """ |
---|
| 166 | # Check whether we already have a graph with the same units |
---|
| 167 | # as the plottable we just received. |
---|
| 168 | _, x_unit = data.get_xaxis() |
---|
| 169 | _, y_unit = data.get_yaxis() |
---|
| 170 | if x_unit != panel.graph.prop["xunit"] \ |
---|
| 171 | or y_unit != panel.graph.prop["yunit"]: |
---|
| 172 | msg = "Cannot add %s" % str(data.name) |
---|
| 173 | msg += " to panel %s\n" % str(panel.window_caption) |
---|
| 174 | msg += "Please edit %s's units, labels" % str(data.name) |
---|
| 175 | raise ValueError, msg |
---|
| 176 | else: |
---|
| 177 | panel.plot_data( data) |
---|
| 178 | self.parent.show_panel(panel.uid) |
---|
| 179 | |
---|
[00b76931] | 180 | def delete_panel(self, group_id): |
---|
| 181 | """ |
---|
| 182 | """ |
---|
| 183 | if group_id in self.plot_panels.keys(): |
---|
| 184 | panel = self.plot_panels[group_id] |
---|
| 185 | #remove menu item |
---|
| 186 | self.menu.Delete(panel.uid) |
---|
| 187 | self.parent.delete_panel(panel.uid) |
---|
| 188 | del self.plot_panels[group_id] |
---|
| 189 | return True |
---|
| 190 | return False |
---|
| 191 | |
---|
[41d466f] | 192 | def _on_plot_event(self, event): |
---|
| 193 | """ |
---|
[d955bf19] | 194 | A new plottable is being shipped to the plotting plug-in. |
---|
| 195 | Check whether we have a panel to put in on, or create |
---|
| 196 | a new one |
---|
| 197 | |
---|
| 198 | :param event: EVT_NEW_PLOT event |
---|
| 199 | |
---|
[41d466f] | 200 | """ |
---|
[ae83ad3] | 201 | if hasattr(event, 'action'): |
---|
[a07e72f] | 202 | group_id = event.group_id |
---|
[ae83ad3] | 203 | #remove data from panel |
---|
| 204 | if event.action.lower() == 'remove': |
---|
| 205 | id = event.id |
---|
| 206 | return self.remove_plot(group_id, id) |
---|
| 207 | if event.action.lower() == 'hide': |
---|
| 208 | return self.hide_panel(group_id) |
---|
[00b76931] | 209 | if event.action.lower() == 'delete': |
---|
| 210 | return self.delete_panel(group_id) |
---|
[2bdb52b] | 211 | title = None |
---|
| 212 | if hasattr(event, 'title'): |
---|
| 213 | title = event.title |
---|
[00b76931] | 214 | |
---|
[a07e72f] | 215 | data = event.plot |
---|
| 216 | group_id_list = data.group_id |
---|
| 217 | group_id = None |
---|
| 218 | if group_id_list: |
---|
| 219 | group_id = group_id_list[len(group_id_list)-1] |
---|
[ae83ad3] | 220 | |
---|
| 221 | if group_id in self.plot_panels.keys(): |
---|
| 222 | #update a panel graph |
---|
| 223 | panel = self.plot_panels[group_id] |
---|
| 224 | self.update_panel(data, panel) |
---|
[a07e72f] | 225 | else: |
---|
[ae83ad3] | 226 | #create a new panel |
---|
[a07e72f] | 227 | if issubclass(data.__class__, Data1D): |
---|
[ae83ad3] | 228 | new_panel = self.create_1d_panel(data, group_id) |
---|
[a07e72f] | 229 | else: |
---|
[ae83ad3] | 230 | new_panel = self.create_2d_panel(data, group_id) |
---|
[2bdb52b] | 231 | self.create_panel_helper(new_panel, data, group_id, title) |
---|
[41d466f] | 232 | |
---|
| 233 | return |
---|
[a07e72f] | 234 | |
---|