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

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 6053bfd was 6053bfd, checked in by lewis, 8 years ago

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