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

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

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