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

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

Remove duplicate error messages

  • Property mode set to 100644
File size: 20.8 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 not self._validate_inputs:
155            msg = "Invalid Q range entered."
156            wx.PostEvent(self.parent.parent, StatusEvent(status=msg))
157            return
158        self._calculator.set_data(self._data)
159        self._calculator.lowerq = self.qmin
160        self._calculator.upperq = self.qmax
161        self._calculator.background = self.background
162        try:
163            self._extrapolated_data = self._calculator.compute_extrapolation()
164        except:
165            msg = "Error extrapolating data."
166            wx.PostEvent(self._manager.parent,
167                StatusEvent(status=msg, info="Error"))
168            self._transform_btn.Disable()
169            return
170        # TODO: Find way to set xlim and ylim so full range of data can be
171        # plotted
172        maxq = self._data.x.max()
173        mask = self._extrapolated_data.x <= maxq
174        numpts = len(self._extrapolated_data.x[mask]) + 250
175        plot_x = self._extrapolated_data.x[0:numpts]
176        plot_y = self._extrapolated_data.y[0:numpts]
177        to_plot = Data1D(plot_x, plot_y)
178        from sas.sasgui.perspectives.corfunc.corfunc import\
179            IQ_EXTRAPOLATED_DATA_LABEL
180        self._manager.show_data(to_plot, IQ_EXTRAPOLATED_DATA_LABEL)
181        self._transform_btn.Enable()
182
183    def compute_transform(self, event=None):
184        """
185        Compute and plot the transformed data.
186        Called when Transform button is pressed.
187        """
188        try:
189            transformed_data = self._calculator.compute_transform(
190                self._extrapolated_data, self.background)
191        except:
192            transformed_data = None
193        if transformed_data is None:
194            msg = "Error calculating Transform."
195            wx.PostEvent(self._manager.parent,
196                StatusEvent(status=msg, info="Error"))
197            self._extract_btn.Disable()
198            return
199        self._transformed_data = transformed_data
200        from sas.sasgui.perspectives.corfunc.corfunc import TRANSFORM_LABEL
201        import numpy as np
202        plot_x = transformed_data.x[np.where(transformed_data.x <= 200)]
203        plot_y = transformed_data.y[np.where(transformed_data.x <= 200)]
204        self._manager.show_data(Data1D(plot_x, plot_y), TRANSFORM_LABEL)
205        self._extract_btn.Enable()
206
207    def extract_parameters(self, event=None):
208        try:
209            params = self._calculator.extract_parameters(self._transformed_data)
210        except:
211            params = None
212        if params is None:
213            msg = "Error extracting parameters."
214            wx.PostEvent(self._manager.parent,
215                StatusEvent(status=msg, info="Error"))
216            return
217        for key in OUTPUT_STRINGS.keys():
218            value = params[key]
219            self._output_boxes[key].SetValue(value)
220
221
222
223    def save_project(self, doc=None):
224        """
225        Return an XML node containing the state of the panel
226
227        :param doc: Am xml node to attach the project state to (optional)
228        """
229        data = self._data
230        state = self.get_state()
231        if data is not None:
232            new_doc, sasentry = self._manager.state_reader._to_xml_doc(data)
233            new_doc = state.toXML(doc=new_doc, entry_node=sasentry)
234            if new_doc is not None:
235                if doc is not None and hasattr(doc, "firstChild"):
236                    child = new_doc.getElementsByTagName("SASentry")
237                    for item in child:
238                        doc.firstChild.appendChild(item)
239                else:
240                    doc = new_doc
241        return doc
242
243    def set_qmin(self, qmin):
244        self.qmin = qmin
245        self._qmin_input.SetValue(str(qmin))
246
247    def set_qmax(self, qmax):
248        self.qmax = qmax
249        self._qmax1_input.SetValue(str(qmax[0]))
250        self._qmax2_input.SetValue(str(qmax[1]))
251
252    def set_background(self, bg):
253        self.background = bg
254        self._background_input.SetValue(str(bg))
255        self._calculator.background = bg
256
257    def _compute_background(self, event=None):
258        self.set_background(self._calculator.compute_background(self.qmax))
259
260    def _on_enter_input(self, event=None):
261        """
262        Read values from input boxes and save to memory.
263        """
264        if event is not None: event.Skip()
265        if not self._validate_inputs():
266            return
267        self.qmin = float(self._qmin_input.GetValue())
268        new_qmax1 = float(self._qmax1_input.GetValue())
269        new_qmax2 = float(self._qmax2_input.GetValue())
270        self.qmax = (new_qmax1, new_qmax2)
271        self.background = float(self._background_input.GetValue())
272        self._calculator.background = self.background
273        from sas.sasgui.perspectives.corfunc.corfunc import GROUP_ID_IQ_DATA,\
274            IQ_DATA_LABEL
275        if event is not None:
276            active_ctrl = event.GetEventObject()
277            if active_ctrl == self._background_input:
278                from sas.sasgui.perspectives.corfunc.corfunc\
279                    import IQ_DATA_LABEL
280                self._manager.show_data(self._data, IQ_DATA_LABEL, reset=False)
281            wx.PostEvent(self._manager.parent, PlotQrangeEvent(
282                ctrl=[self._qmin_input, self._qmax1_input, self._qmax2_input],
283                active=active_ctrl, id=IQ_DATA_LABEL, is_corfunc=True,
284                group_id=GROUP_ID_IQ_DATA, leftdown=False))
285
286    def _on_click_qrange(self, event=None):
287        if event is None:
288            return
289        event.Skip()
290        if not self._validate_inputs(): return
291        is_click = event.LeftDown()
292        if is_click:
293            from sas.sasgui.perspectives.corfunc.corfunc import GROUP_ID_IQ_DATA,\
294                IQ_DATA_LABEL
295            wx.PostEvent(self._manager.parent, PlotQrangeEvent(
296                ctrl=[self._qmin_input, self._qmax1_input, self._qmax2_input],
297                active=event.GetEventObject(), id=IQ_DATA_LABEL,
298                group_id=GROUP_ID_IQ_DATA, leftdown=is_click))
299
300    def _validate_inputs(self):
301        """
302        Check that the values for qmin and qmax in the input boxes are valid
303        """
304        if self._data is None:
305            return False
306        qmin_valid = check_float(self._qmin_input)
307        qmax1_valid = check_float(self._qmax1_input)
308        qmax2_valid = check_float(self._qmax2_input)
309        qmax_valid = qmax1_valid and qmax2_valid
310        background_valid = check_float(self._background_input)
311        msg = ""
312        if (qmin_valid and qmax_valid and background_valid):
313            qmin = float(self._qmin_input.GetValue())
314            qmax1 = float(self._qmax1_input.GetValue())
315            qmax2 = float(self._qmax2_input.GetValue())
316            background = float(self._background_input.GetValue())
317            if not qmin > self._data.x.min():
318                msg = "qmin must be greater than the lowest q value"
319                qmin_valid = False
320            elif qmax2 < qmax1:
321                msg = "qmax1 must be less than qmax2"
322                qmax_valid = False
323            elif qmin > qmax1:
324                msg = "qmin must be less than qmax"
325                qmin_valid = False
326            elif background > self._data.y.max():
327                msg = "background must be less than highest I"
328                background_valid = False
329        if not qmin_valid:
330            self._qmin_input.SetBackgroundColour('pink')
331        if not qmax_valid:
332            self._qmax1_input.SetBackgroundColour('pink')
333            self._qmax2_input.SetBackgroundColour('pink')
334        if not background_valid:
335            self._background_input.SetBackgroundColour('pink')
336            if msg != "":
337                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
338        if (qmin_valid and qmax_valid and background_valid):
339            self._qmin_input.SetBackgroundColour(wx.WHITE)
340            self._qmax1_input.SetBackgroundColour(wx.WHITE)
341            self._qmax2_input.SetBackgroundColour(wx.WHITE)
342            self._background_input.SetBackgroundColour(wx.WHITE)
343        self._qmin_input.Refresh()
344        self._qmax1_input.Refresh()
345        self._qmax2_input.Refresh()
346        self._background_input.Refresh()
347        return (qmin_valid and qmax_valid and background_valid)
348
349    def _do_layout(self):
350        """
351        Draw the window content
352        """
353        vbox = wx.GridBagSizer(0,0)
354
355        # I(q) data box
356        databox = wx.StaticBox(self, -1, "I(Q) Data Source")
357        databox_sizer = wx.StaticBoxSizer(databox, wx.VERTICAL)
358
359        file_sizer = wx.GridBagSizer(5, 5)
360
361        file_name_label = wx.StaticText(self, -1, "Name:")
362        file_sizer.Add(file_name_label, (0, 0), (1, 1),
363            wx.LEFT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
364
365        self._data_name_box = OutputTextCtrl(self, -1,
366            size=(300,20))
367        file_sizer.Add(self._data_name_box, (0, 1), (1, 1),
368            wx.CENTER | wx.ADJUST_MINSIZE, 15)
369
370        file_sizer.AddSpacer((1, 25), pos=(0,2))
371        databox_sizer.Add(file_sizer, wx.TOP, 15)
372
373        vbox.Add(databox_sizer, (0, 0), (1, 1),
374            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE | wx.TOP, 15)
375
376
377        # Parameters
378        qbox = wx.StaticBox(self, -1, "Parameters")
379        qbox_sizer = wx.StaticBoxSizer(qbox, wx.VERTICAL)
380        qbox_sizer.SetMinSize((_STATICBOX_WIDTH, 75))
381
382        q_sizer = wx.GridBagSizer(5, 5)
383
384        # Explanation
385        explanation_txt = ("Corfunc will use all values in the lower range for"
386            " Guinier back extrapolation, and all values in the upper range "
387            "for Porod forward extrapolation.")
388        explanation_label = wx.StaticText(self, -1, explanation_txt,
389            size=(_STATICBOX_WIDTH, 60))
390
391        q_sizer.Add(explanation_label, (0,0), (1,4), wx.LEFT | wx.EXPAND, 5)
392
393        qrange_label = wx.StaticText(self, -1, "Q Range:", size=(50,20))
394        q_sizer.Add(qrange_label, (1,0), (1,1), wx.LEFT | wx.EXPAND, 5)
395
396        # Lower Q Range
397        qmin_label = wx.StaticText(self, -1, "Lower:", size=(50,20))
398        qmin_dash_label = wx.StaticText(self, -1, "-", size=(10,20),
399            style=wx.ALIGN_CENTER_HORIZONTAL)
400
401        qmin_lower = OutputTextCtrl(self, -1, size=(50, 20), value="0.0")
402        self._qmin_input = ModelTextCtrl(self, -1, size=(50, 20),
403                        style=wx.TE_PROCESS_ENTER, name='qmin_input',
404                        text_enter_callback=self._on_enter_input)
405        self._qmin_input.SetToolTipString(("Values with q < qmin will be used "
406            "for Guinier back extrapolation"))
407
408        q_sizer.Add(qmin_label, (2, 0), (1, 1), wx.LEFT | wx.EXPAND, 5)
409        q_sizer.Add(qmin_lower, (2, 1), (1, 1), wx.LEFT, 5)
410        q_sizer.Add(qmin_dash_label, (2, 2), (1, 1), wx.CENTER | wx.EXPAND, 5)
411        q_sizer.Add(self._qmin_input, (2, 3), (1, 1), wx.LEFT, 5)
412
413        # Upper Q range
414        qmax_tooltip = ("Values with qmax1 < q < qmax2 will be used for Porod"
415            " forward extrapolation")
416
417        qmax_label = wx.StaticText(self, -1, "Upper:", size=(50,20))
418        qmax_dash_label = wx.StaticText(self, -1, "-", size=(10,20),
419            style=wx.ALIGN_CENTER_HORIZONTAL)
420
421        self._qmax1_input = ModelTextCtrl(self, -1, size=(50, 20),
422            style=wx.TE_PROCESS_ENTER, name="qmax1_input",
423            text_enter_callback=self._on_enter_input)
424        self._qmax1_input.SetToolTipString(qmax_tooltip)
425        self._qmax2_input = ModelTextCtrl(self, -1, size=(50, 20),
426            style=wx.TE_PROCESS_ENTER, name="qmax2_input",
427            text_enter_callback=self._on_enter_input)
428        self._qmax2_input.SetToolTipString(qmax_tooltip)
429
430        q_sizer.Add(qmax_label, (3, 0), (1, 1), wx.LEFT | wx.EXPAND, 5)
431        q_sizer.Add(self._qmax1_input, (3, 1), (1, 1), wx.LEFT, 5)
432        q_sizer.Add(qmax_dash_label, (3, 2), (1, 1), wx.CENTER | wx.EXPAND, 5)
433        q_sizer.Add(self._qmax2_input, (3,3), (1, 1), wx.LEFT, 5)
434
435        background_label = wx.StaticText(self, -1, "Background:", size=(80,20))
436        q_sizer.Add(background_label, (4,0), (1,1), wx.LEFT | wx.EXPAND, 5)
437
438        self._background_input = ModelTextCtrl(self, -1, size=(50,20),
439            style=wx.TE_PROCESS_ENTER, name='background_input',
440            text_enter_callback=self._on_enter_input)
441        self._background_input.SetToolTipString(("A background value to "
442            "subtract from all intensity values"))
443        q_sizer.Add(self._background_input, (4,1), (1,1),
444            wx.RIGHT, 5)
445
446        background_button = wx.Button(self, wx.NewId(), "Calculate",
447            size=(75, 20))
448        background_button.Bind(wx.EVT_BUTTON, self._compute_background)
449        q_sizer.Add(background_button, (4, 2), (1, 1), wx.RIGHT, 5)
450
451        qbox_sizer.Add(q_sizer, wx.TOP, 0)
452
453        vbox.Add(qbox_sizer, (1, 0), (1, 1),
454            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
455
456        # Output data
457        outputbox = wx.StaticBox(self, -1, "Output Measuments")
458        outputbox_sizer = wx.StaticBoxSizer(outputbox, wx.VERTICAL)
459
460        output_sizer = wx.GridBagSizer(5, 5)
461
462        self._output_boxes = dict()
463        i = 0
464        for key, value in OUTPUT_STRINGS.iteritems():
465            # Create a label and a text box for each poperty
466            label = wx.StaticText(self, -1, value)
467            output_box = OutputTextCtrl(self, wx.NewId(),
468                value="-", style=wx.ALIGN_CENTER_HORIZONTAL)
469            # Save the ID of each of the text boxes for accessing after the
470            # output data has been calculated
471            self._output_boxes[key] = output_box
472            output_sizer.Add(label, (i, 0), (1, 1), wx.LEFT | wx.EXPAND, 15)
473            output_sizer.Add(output_box, (i, 2), (1, 1),
474                wx.RIGHT | wx.EXPAND, 15)
475            i += 1
476
477        outputbox_sizer.Add(output_sizer, wx.TOP, 0)
478
479        vbox.Add(outputbox_sizer, (2, 0), (1, 1),
480            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
481
482        # Controls
483        controlbox = wx.StaticBox(self, -1, "Controls")
484        controlbox_sizer = wx.StaticBoxSizer(controlbox, wx.VERTICAL)
485
486        controls_sizer = wx.BoxSizer(wx.VERTICAL)
487
488        extrapolate_btn = wx.Button(self, wx.NewId(), "Extrapolate")
489        self._transform_btn = wx.Button(self, wx.NewId(), "Transform")
490        self._extract_btn = wx.Button(self, wx.NewId(), "Compute Measuments")
491
492        self._transform_btn.Disable()
493        self._extract_btn.Disable()
494
495        extrapolate_btn.Bind(wx.EVT_BUTTON, self.compute_extrapolation)
496        self._transform_btn.Bind(wx.EVT_BUTTON, self.compute_transform)
497        self._extract_btn.Bind(wx.EVT_BUTTON, self.extract_parameters)
498
499        controls_sizer.Add(extrapolate_btn, wx.CENTER | wx.EXPAND)
500        controls_sizer.Add(self._transform_btn, wx.CENTER | wx.EXPAND)
501        controls_sizer.Add(self._extract_btn, wx.CENTER | wx.EXPAND)
502
503        controlbox_sizer.Add(controls_sizer, wx.TOP | wx.EXPAND, 0)
504        vbox.Add(controlbox_sizer, (3, 0), (1, 1),
505            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
506
507        self.SetSizer(vbox)
508
509    def _disable_inputs(self):
510        """
511        Disable all input fields
512        """
513        self._qmin_input.Disable()
514        self._qmax1_input.Disable()
515        self._qmax2_input.Disable()
516        self._background_input.Disable()
517
518    def _enable_inputs(self):
519        """
520        Enable all input fields
521        """
522        self._qmin_input.Enable()
523        self._qmax1_input.Enable()
524        self._qmax2_input.Enable()
525        self._background_input.Enable()
Note: See TracBrowser for help on using the repository browser.