source: sasview/src/sas/sasgui/perspectives/corfunc/corfunc_panel.py @ f4622db

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.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since f4622db was f4622db, checked in by lewis, 8 years ago

Allow moving of qrange bars with mouse (in corfunc)

  • Property mode set to 100644
File size: 19.7 KB
Line 
1import wx
2import sys
3from wx.lib.scrolledpanel import ScrolledPanel
4from sas.sasgui.guiframe.events import PlotQrangeEvent
5from sas.sasgui.guiframe.events import StatusEvent
6from sas.sasgui.guiframe.panel_base import PanelBase
7from sas.sasgui.guiframe.utils import check_float
8from sas.sasgui.guiframe.dataFitting import Data1D
9from sas.sasgui.perspectives.invariant.invariant_widgets import OutputTextCtrl
10from sas.sasgui.perspectives.invariant.invariant_widgets import InvTextCtrl
11from sas.sasgui.perspectives.fitting.basepage import ModelTextCtrl
12from sas.sasgui.perspectives.corfunc.corfunc_state import CorfuncState
13import sas.sasgui.perspectives.corfunc.corfunc
14from sas.sascalc.corfunc.corfunc_calculator import CorfuncCalculator
15
16if sys.platform.count("win32") > 0:
17    _STATICBOX_WIDTH = 350
18    PANEL_WIDTH = 400
19    PANEL_HEIGHT = 700
20    FONT_VARIANT = 0
21else:
22    _STATICBOX_WIDTH = 390
23    PANEL_WIDTH = 430
24    PANEL_HEIGHT = 700
25    FONT_VARIANT = 1
26
27class CorfuncPanel(ScrolledPanel,PanelBase):
28    window_name = "Correlation Function"
29    window_caption = "Correlation Function"
30    CENTER_PANE = True
31
32    def __init__(self, parent, data=None, manager=None, *args, **kwds):
33        kwds["size"] = (PANEL_WIDTH, PANEL_HEIGHT)
34        kwds["style"] = wx.FULL_REPAINT_ON_RESIZE
35        ScrolledPanel.__init__(self, parent=parent, *args, **kwds)
36        PanelBase.__init__(self, parent)
37        self.SetupScrolling()
38        self.SetWindowVariant(variant=FONT_VARIANT)
39        self._manager = manager
40        # The data with no correction for background values
41        self._data = data # The data to be analysed (corrected fr background)
42        self._extrapolated_data = None # The extrapolated data set
43        self._calculator = CorfuncCalculator()
44        self._data_name_box = None # Text box to show name of file
45        self._background_input = None
46        self._qmin_input = None
47        self._qmax1_input = None
48        self._qmax2_input = None
49        self._transform_btn = None
50        self._compute_btn = None
51        self.qmin = 0
52        self.qmax = (0, 0)
53        self.background = 0
54        # Dictionary for saving IDs of text boxes used to display output data
55        self._output_ids = None
56        self.state = None
57        self._do_layout()
58        self._disable_inputs()
59        self.set_state()
60        self._qmin_input.Bind(wx.EVT_TEXT, self._on_enter_input)
61        self._qmax1_input.Bind(wx.EVT_TEXT, self._on_enter_input)
62        self._qmax2_input.Bind(wx.EVT_TEXT, self._on_enter_input)
63        self._qmin_input.Bind(wx.EVT_MOUSE_EVENTS, self._on_click_qrange)
64        self._qmax1_input.Bind(wx.EVT_MOUSE_EVENTS, self._on_click_qrange)
65        self._qmax2_input.Bind(wx.EVT_MOUSE_EVENTS, self._on_click_qrange)
66        self._background_input.Bind(wx.EVT_TEXT, self._on_enter_input)
67
68    def set_state(self, state=None, data=None):
69        """
70        Set the state of the panel. If no state is provided, the panel will
71        be set to the default state.
72
73        :param state: A CorfuncState object
74        :param data: A Data1D object
75        """
76        if state is None:
77            self.state = CorfuncState()
78        else:
79            self.state = state
80        if data is not None:
81            self.state.data = data
82        self.set_data(data, set_qrange=False)
83        if self.state.qmin is not None:
84            self.set_qmin(self.state.qmin)
85        if self.state.qmax is not None and self.state.qmax != (None, None):
86            self.set_qmax(tuple(self.state.qmax))
87        if self.state.background is not None:
88            self.set_background(self.state.background)
89
90    def get_state(self):
91        """
92        Return the state of the panel
93        """
94        state = CorfuncState()
95        state.set_saved_state('qmin_tcl', self.qmin)
96        state.set_saved_state('qmax1_tcl', self.qmax[0])
97        state.set_saved_state('qmax2_tcl', self.qmax[1])
98        state.set_saved_state('background_tcl', self.background)
99        if self._data is not None:
100            state.file = self._data.title
101            state.data = self._data
102        self.state = state
103
104        return self.state
105
106    def onSetFocus(self, evt):
107        if evt is not None:
108            evt.Skip()
109        self._validate_inputs()
110
111    def set_data(self, data=None, set_qrange=True):
112        """
113        Update the GUI to reflect new data that has been loaded in
114
115        :param data: The data that has been loaded
116        """
117        if data is None:
118            return
119        self._enable_inputs()
120        self._transform_btn.Disable()
121        self._data_name_box.SetValue(str(data.title))
122        self._data = data
123        self._calculator.set_data(data)
124        if self._manager is not None:
125            from sas.sasgui.perspectives.corfunc.corfunc import IQ_DATA_LABEL
126            self._manager.show_data(self._data, IQ_DATA_LABEL, reset=True)
127        if set_qrange:
128            lower = data.x[-1]*0.05
129            upper1 = data.x[-1] - lower*5
130            upper2 = data.x[-1]
131            self.set_qmin(lower)
132            self.set_qmax((upper1, upper2))
133            self.set_background(self._calculator.compute_background(self.qmax))
134
135    def get_data(self):
136        return self._data
137
138    def compute_extrapolation(self, event=None):
139        """
140        Compute and plot the extrapolated data.
141        Called when Extrapolate button is pressed.
142        """
143        if self._data is None:
144            msg = "Data must be loaded in order to perform an extrapolation."
145            wx.PostEvent(self.parent.parent, StatusEvent(status=msg))
146            return
147        if not self._validate_inputs:
148            msg = "Invalid Q range entered."
149            wx.PostEvent(self.parent.parent, StatusEvent(status=msg))
150            return
151        self._calculator.set_data(self._data)
152        self._calculator.lowerq = self.qmin
153        self._calculator.upperq = self.qmax
154        self._calculator.background = self.background
155        self._extrapolated_data = self._calculator.compute_extrapolation()
156        # TODO: Find way to set xlim and ylim so full range of data can be
157        # plotted
158        maxq = self._data.x.max()
159        mask = self._extrapolated_data.x <= maxq
160        numpts = len(self._extrapolated_data.x[mask]) + 250
161        plot_x = self._extrapolated_data.x[0:numpts]
162        plot_y = self._extrapolated_data.y[0:numpts]
163        to_plot = Data1D(plot_x, plot_y)
164        from sas.sasgui.perspectives.corfunc.corfunc import\
165            IQ_EXTRAPOLATED_DATA_LABEL
166        self._manager.show_data(to_plot, IQ_EXTRAPOLATED_DATA_LABEL)
167        self._transform_btn.Enable()
168
169    def compute_transform(self, event=None):
170        """
171        Compute and plot the transformed data.
172        Called when Transform button is pressed.
173        """
174        transformed_data = self._calculator.compute_transform(
175            self._extrapolated_data, self.background)
176        from sas.sasgui.perspectives.corfunc.corfunc import TRANSFORM_LABEL
177        import numpy as np
178        plot_x = transformed_data.x[np.where(transformed_data.x <= 200)]
179        plot_y = transformed_data.y[np.where(transformed_data.x <= 200)]
180        self._manager.show_data(Data1D(plot_x, plot_y), TRANSFORM_LABEL)
181
182
183    def save_project(self, doc=None):
184        """
185        Return an XML node containing the state of the panel
186
187        :param doc: Am xml node to attach the project state to (optional)
188        """
189        data = self._data
190        state = self.get_state()
191        if data is not None:
192            new_doc, sasentry = self._manager.state_reader._to_xml_doc(data)
193            new_doc = state.toXML(doc=new_doc, entry_node=sasentry)
194            if new_doc is not None:
195                if doc is not None and hasattr(doc, "firstChild"):
196                    child = new_doc.getElementsByTagName("SASentry")
197                    for item in child:
198                        doc.firstChild.appendChild(item)
199                else:
200                    doc = new_doc
201        return doc
202
203    def set_qmin(self, qmin):
204        self.qmin = qmin
205        self._qmin_input.SetValue(str(qmin))
206
207    def set_qmax(self, qmax):
208        self.qmax = qmax
209        self._qmax1_input.SetValue(str(qmax[0]))
210        self._qmax2_input.SetValue(str(qmax[1]))
211
212    def set_background(self, bg):
213        self.background = bg
214        self._background_input.SetValue(str(bg))
215        self._calculator.background = bg
216
217    def _compute_background(self, event=None):
218        self.set_background(self._calculator.compute_background(self.qmax))
219
220    def _on_enter_input(self, event=None):
221        """
222        Read values from input boxes and save to memory.
223        """
224        if event is not None: event.Skip()
225        if not self._validate_inputs():
226            return
227        self.qmin = float(self._qmin_input.GetValue())
228        new_qmax1 = float(self._qmax1_input.GetValue())
229        new_qmax2 = float(self._qmax2_input.GetValue())
230        self.qmax = (new_qmax1, new_qmax2)
231        self.background = float(self._background_input.GetValue())
232        self._calculator.background = self.background
233        from sas.sasgui.perspectives.corfunc.corfunc import GROUP_ID_IQ_DATA,\
234            IQ_DATA_LABEL
235        if event is not None:
236            active_ctrl = event.GetEventObject()
237            if active_ctrl == self._background_input:
238                from sas.sasgui.perspectives.corfunc.corfunc\
239                    import IQ_DATA_LABEL
240                self._manager.show_data(self._data, IQ_DATA_LABEL, reset=False)
241            wx.PostEvent(self._manager.parent, PlotQrangeEvent(
242                ctrl=[self._qmin_input, self._qmax1_input, self._qmax2_input],
243                active=active_ctrl, id=IQ_DATA_LABEL, is_corfunc=True,
244                group_id=GROUP_ID_IQ_DATA, leftdown=False))
245
246    def _on_click_qrange(self, event=None):
247        if event is None:
248            return
249        event.Skip()
250        if not self._validate_inputs(): return
251        is_click = event.LeftDown()
252        if is_click:
253            from sas.sasgui.perspectives.corfunc.corfunc import GROUP_ID_IQ_DATA,\
254                IQ_DATA_LABEL
255            wx.PostEvent(self._manager.parent, PlotQrangeEvent(
256                ctrl=[self._qmin_input, self._qmax1_input, self._qmax2_input],
257                active=event.GetEventObject(), id=IQ_DATA_LABEL,
258                group_id=GROUP_ID_IQ_DATA, leftdown=is_click))
259
260    def _validate_inputs(self):
261        """
262        Check that the values for qmin and qmax in the input boxes are valid
263        """
264        if self._data is None:
265            return False
266        qmin_valid = check_float(self._qmin_input)
267        qmax1_valid = check_float(self._qmax1_input)
268        qmax2_valid = check_float(self._qmax2_input)
269        qmax_valid = qmax1_valid and qmax2_valid
270        background_valid = check_float(self._background_input)
271        msg = ""
272        if (qmin_valid and qmax_valid and background_valid):
273            qmin = float(self._qmin_input.GetValue())
274            qmax1 = float(self._qmax1_input.GetValue())
275            qmax2 = float(self._qmax2_input.GetValue())
276            background = float(self._background_input.GetValue())
277            if not qmin > self._data.x.min():
278                msg = "qmin must be greater than the lowest q value"
279                qmin_valid = False
280            elif qmax2 < qmax1:
281                msg = "qmax1 must be less than qmax2"
282                qmax_valid = False
283            elif qmin > qmax1:
284                msg = "qmin must be less than qmax"
285                qmin_valid = False
286            elif background < 0 or background > self._data.y.max():
287                msg = "background must be positive and less than highest I"
288                background_valid = False
289        if not qmin_valid:
290            self._qmin_input.SetBackgroundColour('pink')
291        if not qmax_valid:
292            self._qmax1_input.SetBackgroundColour('pink')
293            self._qmax2_input.SetBackgroundColour('pink')
294        if not background_valid:
295            self._background_input.SetBackgroundColour('pink')
296            if msg != "":
297                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
298        if (qmin_valid and qmax_valid and background_valid):
299            self._qmin_input.SetBackgroundColour(wx.WHITE)
300            self._qmax1_input.SetBackgroundColour(wx.WHITE)
301            self._qmax2_input.SetBackgroundColour(wx.WHITE)
302            self._background_input.SetBackgroundColour(wx.WHITE)
303        self._qmin_input.Refresh()
304        self._qmax1_input.Refresh()
305        self._qmax2_input.Refresh()
306        self._background_input.Refresh()
307        return (qmin_valid and qmax_valid and background_valid)
308
309    def _do_layout(self):
310        """
311        Draw the window content
312        """
313        vbox = wx.GridBagSizer(0,0)
314
315        # I(q) data box
316        databox = wx.StaticBox(self, -1, "I(Q) Data Source")
317        databox_sizer = wx.StaticBoxSizer(databox, wx.VERTICAL)
318
319        file_sizer = wx.GridBagSizer(5, 5)
320
321        file_name_label = wx.StaticText(self, -1, "Name:")
322        file_sizer.Add(file_name_label, (0, 0), (1, 1),
323            wx.LEFT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
324
325        self._data_name_box = OutputTextCtrl(self, -1,
326            size=(300,20))
327        file_sizer.Add(self._data_name_box, (0, 1), (1, 1),
328            wx.CENTER | wx.ADJUST_MINSIZE, 15)
329
330        file_sizer.AddSpacer((1, 25), pos=(0,2))
331        databox_sizer.Add(file_sizer, wx.TOP, 15)
332
333        vbox.Add(databox_sizer, (0, 0), (1, 1),
334            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE | wx.TOP, 15)
335
336
337        # Parameters
338        qbox = wx.StaticBox(self, -1, "Parameters")
339        qbox_sizer = wx.StaticBoxSizer(qbox, wx.VERTICAL)
340        qbox_sizer.SetMinSize((_STATICBOX_WIDTH, 75))
341
342        q_sizer = wx.GridBagSizer(5, 5)
343
344        # Explanation
345        explanation_txt = ("Corfunc will use all values in the lower range for"
346            " Guinier back extrapolation, and all values in the upper range "
347            "for Porod forward extrapolation.")
348        explanation_label = wx.StaticText(self, -1, explanation_txt,
349            size=(_STATICBOX_WIDTH, 60))
350
351        q_sizer.Add(explanation_label, (0,0), (1,4), wx.LEFT | wx.EXPAND, 5)
352
353        qrange_label = wx.StaticText(self, -1, "Q Range:", size=(50,20))
354        q_sizer.Add(qrange_label, (1,0), (1,1), wx.LEFT | wx.EXPAND, 5)
355
356        # Lower Q Range
357        qmin_label = wx.StaticText(self, -1, "Lower:", size=(50,20))
358        qmin_dash_label = wx.StaticText(self, -1, "-", size=(10,20),
359            style=wx.ALIGN_CENTER_HORIZONTAL)
360
361        qmin_lower = OutputTextCtrl(self, -1, size=(50, 20), value="0.0")
362        self._qmin_input = ModelTextCtrl(self, -1, size=(50, 20),
363                        style=wx.TE_PROCESS_ENTER, name='qmin_input',
364                        text_enter_callback=self._on_enter_input)
365        self._qmin_input.SetToolTipString(("Values with q < qmin will be used "
366            "for Guinier back extrapolation"))
367
368        q_sizer.Add(qmin_label, (2, 0), (1, 1), wx.LEFT | wx.EXPAND, 5)
369        q_sizer.Add(qmin_lower, (2, 1), (1, 1), wx.LEFT, 5)
370        q_sizer.Add(qmin_dash_label, (2, 2), (1, 1), wx.CENTER | wx.EXPAND, 5)
371        q_sizer.Add(self._qmin_input, (2, 3), (1, 1), wx.LEFT, 5)
372
373        # Upper Q range
374        qmax_tooltip = ("Values with qmax1 < q < qmax2 will be used for Porod"
375            " forward extrapolation")
376
377        qmax_label = wx.StaticText(self, -1, "Upper:", size=(50,20))
378        qmax_dash_label = wx.StaticText(self, -1, "-", size=(10,20),
379            style=wx.ALIGN_CENTER_HORIZONTAL)
380
381        self._qmax1_input = ModelTextCtrl(self, -1, size=(50, 20),
382            style=wx.TE_PROCESS_ENTER, name="qmax1_input",
383            text_enter_callback=self._on_enter_input)
384        self._qmax1_input.SetToolTipString(qmax_tooltip)
385        self._qmax2_input = ModelTextCtrl(self, -1, size=(50, 20),
386            style=wx.TE_PROCESS_ENTER, name="qmax2_input",
387            text_enter_callback=self._on_enter_input)
388        self._qmax2_input.SetToolTipString(qmax_tooltip)
389
390        q_sizer.Add(qmax_label, (3, 0), (1, 1), wx.LEFT | wx.EXPAND, 5)
391        q_sizer.Add(self._qmax1_input, (3, 1), (1, 1), wx.LEFT, 5)
392        q_sizer.Add(qmax_dash_label, (3, 2), (1, 1), wx.CENTER | wx.EXPAND, 5)
393        q_sizer.Add(self._qmax2_input, (3,3), (1, 1), wx.LEFT, 5)
394
395        background_label = wx.StaticText(self, -1, "Background:", size=(80,20))
396        q_sizer.Add(background_label, (4,0), (1,1), wx.LEFT | wx.EXPAND, 5)
397
398        self._background_input = ModelTextCtrl(self, -1, size=(50,20),
399            style=wx.TE_PROCESS_ENTER, name='background_input',
400            text_enter_callback=self._on_enter_input)
401        self._background_input.SetToolTipString(("A background value to "
402            "subtract from all intensity values"))
403        q_sizer.Add(self._background_input, (4,1), (1,1),
404            wx.RIGHT, 5)
405
406        background_button = wx.Button(self, wx.NewId(), "Calculate",
407            size=(75, 20))
408        background_button.Bind(wx.EVT_BUTTON, self._compute_background)
409        q_sizer.Add(background_button, (4, 2), (1, 1), wx.RIGHT, 5)
410
411        qbox_sizer.Add(q_sizer, wx.TOP, 0)
412
413        vbox.Add(qbox_sizer, (1, 0), (1, 1),
414            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
415
416        # Output data
417        outputbox = wx.StaticBox(self, -1, "Output Measuments")
418        outputbox_sizer = wx.StaticBoxSizer(outputbox, wx.VERTICAL)
419
420        output_sizer = wx.GridBagSizer(5, 5)
421
422        label_strings = [
423            "Long Period (A): ",
424            "Average Hard Block Thickness (A): ",
425            "Average Interface Thickness (A): ",
426            "Average Core Thickness: ",
427            "PolyDispersity: ",
428            "Filling Fraction: "
429        ]
430        self._output_ids = dict()
431        for i in range(len(label_strings)):
432            # Create a label and a text box for each poperty
433            label = wx.StaticText(self, -1, label_strings[i])
434            output_box = OutputTextCtrl(self, wx.NewId(), size=(50, 20),
435                value="-", style=wx.ALIGN_CENTER_HORIZONTAL)
436            # Save the ID of each of the text boxes for accessing after the
437            # output data has been calculated
438            self._output_ids[label_strings[i]] = output_box.GetId()
439            output_sizer.Add(label, (i, 0), (1, 1), wx.LEFT | wx.EXPAND, 15)
440            output_sizer.Add(output_box, (i, 2), (1, 1),
441                wx.RIGHT | wx.EXPAND, 15)
442
443        outputbox_sizer.Add(output_sizer, wx.TOP, 0)
444
445        vbox.Add(outputbox_sizer, (2, 0), (1, 1),
446            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
447
448        # Controls
449        controlbox = wx.StaticBox(self, -1, "Controls")
450        controlbox_sizer = wx.StaticBoxSizer(controlbox, wx.VERTICAL)
451
452        controls_sizer = wx.BoxSizer(wx.VERTICAL)
453
454        extrapolate_btn = wx.Button(self, wx.NewId(), "Extrapolate")
455        self._transform_btn = wx.Button(self, wx.NewId(), "Transform")
456        self._compute_btn = wx.Button(self, wx.NewId(), "Compute Measuments")
457
458        self._transform_btn.Disable()
459        self._compute_btn.Disable()
460
461        extrapolate_btn.Bind(wx.EVT_BUTTON, self.compute_extrapolation)
462        self._transform_btn.Bind(wx.EVT_BUTTON, self.compute_transform)
463
464        controls_sizer.Add(extrapolate_btn, wx.CENTER | wx.EXPAND)
465        controls_sizer.Add(self._transform_btn, wx.CENTER | wx.EXPAND)
466        controls_sizer.Add(self._compute_btn, wx.CENTER | wx.EXPAND)
467
468        controlbox_sizer.Add(controls_sizer, wx.TOP | wx.EXPAND, 0)
469        vbox.Add(controlbox_sizer, (3, 0), (1, 1),
470            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
471
472        self.SetSizer(vbox)
473
474    def _disable_inputs(self):
475        """
476        Disable all input fields
477        """
478        self._qmin_input.Disable()
479        self._qmax1_input.Disable()
480        self._qmax2_input.Disable()
481        self._background_input.Disable()
482
483    def _enable_inputs(self):
484        """
485        Enable all input fields
486        """
487        self._qmin_input.Enable()
488        self._qmax1_input.Enable()
489        self._qmax2_input.Enable()
490        self._background_input.Enable()
Note: See TracBrowser for help on using the repository browser.