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

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

Add comments/docstrings
  • Property mode set to 100644
File size: 29.5 KB
Line 
1import wx
2import sys
3import numpy as np
4from wx.lib.scrolledpanel import ScrolledPanel
5from sas.sasgui.guiframe.events import PlotQrangeEvent
6from sas.sasgui.guiframe.events import StatusEvent
7from sas.sasgui.guiframe.panel_base import PanelBase
8from sas.sasgui.guiframe.utils import check_float
9from sas.sasgui.guiframe.dataFitting import Data1D
10from sas.sasgui.perspectives.invariant.invariant_widgets import OutputTextCtrl
11from sas.sasgui.perspectives.invariant.invariant_widgets import InvTextCtrl
12from sas.sasgui.perspectives.fitting.basepage import ModelTextCtrl
13from sas.sasgui.perspectives.corfunc.corfunc_state import CorfuncState
14import sas.sasgui.perspectives.corfunc.corfunc
15from sas.sascalc.corfunc.corfunc_calculator import CorfuncCalculator
16from sas.sasgui.guiframe.documentation_window import DocumentationWindow
17from plot_labels import *
18
19OUTPUT_STRINGS = {
20    'max': "Long Period (A): ",
21    'Lc': "Average Hard Block Thickness (A): ",
22    'dtr': "Average Interface Thickness (A): ",
23    'd0': "Average Core Thickness: ",
24    'A': "Polydispersity: ",
25    'fill': "Local Crystallinity: "
26}
27
28if sys.platform.count("win32") > 0:
29    _STATICBOX_WIDTH = 350
30    PANEL_WIDTH = 400
31    PANEL_HEIGHT = 700
32    FONT_VARIANT = 0
33else:
34    _STATICBOX_WIDTH = 390
35    PANEL_WIDTH = 430
36    PANEL_HEIGHT = 700
37    FONT_VARIANT = 1
38
39class CorfuncPanel(ScrolledPanel,PanelBase):
40    window_name = "Correlation Function"
41    window_caption = "Correlation Function"
42    CENTER_PANE = True
43
44    def __init__(self, parent, data=None, manager=None, *args, **kwds):
45        kwds["size"] = (PANEL_WIDTH, PANEL_HEIGHT)
46        kwds["style"] = wx.FULL_REPAINT_ON_RESIZE
47        ScrolledPanel.__init__(self, parent=parent, *args, **kwds)
48        PanelBase.__init__(self, parent)
49        self.SetupScrolling()
50        self.SetWindowVariant(variant=FONT_VARIANT)
51        self._manager = manager
52        # The data with no correction for background values
53        self._data = data # The data to be analysed (corrected fr background)
54        self._extrapolated_data = None # The extrapolated data set
55        self._transformed_data = None # Fourier trans. of the extrapolated data
56        self._calculator = CorfuncCalculator()
57        self._data_name_box = None # Text box to show name of file
58        self._background_input = None
59        self._qmin_input = None
60        self._qmax1_input = None
61        self._qmax2_input = None
62        self._extrapolate_btn = None
63        self._transform_btn = None
64        self._extract_btn = None
65        self.qmin = 0
66        self.qmax = (0, 0)
67        self.background = 0
68        self.extracted_params = None
69        self.transform_type = 'fourier'
70        self._extrapolation_outputs = {}
71        # Dictionary for saving refs to text boxes used to display output data
72        self._output_boxes = None
73        self.state = None
74        self._do_layout()
75        self._disable_inputs()
76        self.set_state()
77        self._qmin_input.Bind(wx.EVT_TEXT, self._on_enter_input)
78        self._qmax1_input.Bind(wx.EVT_TEXT, self._on_enter_input)
79        self._qmax2_input.Bind(wx.EVT_TEXT, self._on_enter_input)
80        self._qmin_input.Bind(wx.EVT_MOUSE_EVENTS, self._on_click_qrange)
81        self._qmax1_input.Bind(wx.EVT_MOUSE_EVENTS, self._on_click_qrange)
82        self._qmax2_input.Bind(wx.EVT_MOUSE_EVENTS, self._on_click_qrange)
83        self._background_input.Bind(wx.EVT_TEXT, self._on_enter_input)
84
85    def set_state(self, state=None, data=None):
86        """
87        Set the state of the panel. If no state is provided, the panel will
88        be set to the default state.
89
90        :param state: A CorfuncState object
91        :param data: A Data1D object
92        """
93        if state is None:
94            self.state = CorfuncState()
95        else:
96            self.state = state
97        if data is not None:
98            self.state.data = data
99        self.set_data(data, set_qrange=False)
100        if self.state.qmin is not None:
101            self.set_qmin(self.state.qmin)
102        if self.state.qmax is not None and self.state.qmax != (None, None):
103            self.set_qmax(tuple(self.state.qmax))
104        if self.state.background is not None:
105            self.set_background(self.state.background)
106        if self.state.is_extrapolated:
107            self.compute_extrapolation()
108        else:
109            return
110        if self.state.is_transformed:
111            self.compute_transform()
112        else:
113            return
114        if self.state.outputs is not None and self.state.outputs != {}:
115            self.set_extracted_params(self.state.outputs, reset=True)
116
117    def get_state(self):
118        """
119        Return the state of the panel
120        """
121        state = CorfuncState()
122        state.set_saved_state('qmin_tcl', self.qmin)
123        state.set_saved_state('qmax1_tcl', self.qmax[0])
124        state.set_saved_state('qmax2_tcl', self.qmax[1])
125        state.set_saved_state('background_tcl', self.background)
126        state.outputs = self.extracted_params
127        if self._data is not None:
128            state.file = self._data.title
129            state.data = self._data
130        if self._extrapolated_data is not None:
131            state.is_extrapolated = True
132        if self._transformed_data is not None:
133            state.is_transformed = True
134        self.state = state
135
136        return self.state
137
138    def onSetFocus(self, evt):
139        if evt is not None:
140            evt.Skip()
141        self._validate_inputs()
142
143    def set_data(self, data=None, set_qrange=True):
144        """
145        Update the GUI to reflect new data that has been loaded in
146
147        :param data: The data that has been loaded
148        """
149        if data is None:
150            self._disable_inputs()
151            # Reset outputs
152            self.set_extracted_params(reset=True)
153            self.set_extrapolation_params()
154            self._data = None
155            return
156        self._enable_inputs()
157        self._transform_btn.Disable()
158        self._extract_btn.Disable()
159        self._data_name_box.SetValue(str(data.title))
160        self._data = data
161        self._calculator.set_data(data)
162        # Reset the outputs
163        self.set_extracted_params(None, reset=True)
164        if self._manager is not None:
165            self._manager.clear_data()
166            self._manager.show_data(self._data, IQ_DATA_LABEL, reset=True)
167
168        if set_qrange:
169            lower = data.x[-1]*0.05
170            upper1 = data.x[-1] - lower*5
171            upper2 = data.x[-1]
172            self.set_qmin(lower)
173            self.set_qmax((upper1, upper2))
174            self._compute_background()
175
176    def get_data(self):
177        return self._data
178
179    def radio_changed(self, event=None):
180        """
181        Called when the "Transform type" radio button are changed
182        """
183        if event is not None:
184            self.transform_type = event.GetEventObject().GetName()
185
186    def compute_extrapolation(self, event=None):
187        """
188        Compute and plot the extrapolated data.
189        Called when Extrapolate button is pressed.
190        """
191        if not self._validate_inputs:
192            msg = "Invalid Q range entered."
193            wx.PostEvent(self.parent.parent, StatusEvent(status=msg))
194            return
195
196        warning_msg = ""
197        if self.background < 0:
198            warning_msg += "Negative background value entered."
199        if any((self._data.y - self.background) < 0):
200            if warning_msg != "":
201                warning_msg += "\n"
202            warning_msg += "Background value results in negative Intensity values."
203        if warning_msg != "":
204            self._background_input.SetBackgroundColour('yellow')
205            wx.PostEvent(self._manager.parent, StatusEvent(status=warning_msg, info='warning'))
206        else:
207            self._background_input.SetBackgroundColour(wx.WHITE)
208        self._background_input.Refresh()
209
210        self._calculator.set_data(self._data)
211        self._calculator.lowerq = self.qmin
212        self._calculator.upperq = self.qmax
213        self._calculator.background = self.background
214
215        try:
216            params, self._extrapolated_data = self._calculator.compute_extrapolation()
217        except Exception as e:
218            msg = "Error extrapolating data:\n"
219            msg += str(e)
220            wx.PostEvent(self._manager.parent,
221                StatusEvent(status=msg, info="error"))
222            self._transform_btn.Disable()
223            return
224        self._manager.show_data(self._extrapolated_data, IQ_EXTRAPOLATED_DATA_LABEL)
225        # Update state of the GUI
226        self._transform_btn.Enable()
227        self._extract_btn.Disable()
228        self.set_extracted_params(reset=True)
229        self.set_extrapolation_params(params)
230
231    def compute_transform(self, event=None):
232        """
233        Compute and plot the transformed data.
234        Called when Transform button is pressed.
235        """
236        if not self._calculator.transform_isrunning():
237            self._calculator.compute_transform(self._extrapolated_data,
238                self.transform_type, background=self.background,
239                completefn=self.transform_complete,
240                updatefn=self.transform_update)
241
242            self._transform_btn.SetLabel("Stop Transform")
243        else:
244            self._calculator.stop_transform()
245            self.transform_update("Transform cancelled.")
246            self._transform_btn.SetLabel("Transform")
247
248    def transform_update(self, msg=""):
249        """
250        Called from FourierThread to update on status of calculation
251        """
252        wx.PostEvent(self._manager.parent,
253            StatusEvent(status=msg))
254
255    def transform_complete(self, transform=None):
256        """
257        Called from FourierThread when calculation has completed
258        """
259        self._transform_btn.SetLabel("Transform")
260        if transform is None:
261            msg = "Error calculating Transform."
262            if self.transform_type == 'hilbert':
263                msg = "Not yet implemented"
264            wx.PostEvent(self._manager.parent,
265                StatusEvent(status=msg, info="Error"))
266            self._extract_btn.Disable()
267            return
268        self._transformed_data = transform
269        import numpy as np
270        plot_x = transform.x[np.where(transform.x <= 200)]
271        plot_y = transform.y[np.where(transform.x <= 200)]
272        self._manager.show_data(Data1D(plot_x, plot_y), TRANSFORM_LABEL)
273        # Only enable extract params button if a fourier trans. has been done
274        if self.transform_type == 'fourier':
275            self._extract_btn.Enable()
276        else:
277            self._extract_btn.Disable()
278
279    def extract_parameters(self, event=None):
280        """
281        Called when "Extract Parameters" is clicked
282        """
283        try:
284            params = self._calculator.extract_parameters(self._transformed_data)
285        except:
286            params = None
287        if params is None:
288            msg = "Error extracting parameters."
289            wx.PostEvent(self._manager.parent,
290                StatusEvent(status=msg, info="Error"))
291            return
292        self.set_extracted_params(params)
293
294    def on_help(self, event=None):
295        """
296        Show the corfunc documentation
297        """
298        tree_location = "user/sasgui/perspectives/corfunc/corfunc_help.html"
299        doc_viewer = DocumentationWindow(self, -1, tree_location, "",
300                                          "Correlation Function Help")
301
302    def save_project(self, doc=None):
303        """
304        Return an XML node containing the state of the panel
305
306        :param doc: Am xml node to attach the project state to (optional)
307        """
308        data = self._data
309        state = self.get_state()
310        if data is not None:
311            new_doc, sasentry = self._manager.state_reader._to_xml_doc(data)
312            new_doc = state.toXML(doc=new_doc, entry_node=sasentry)
313            if new_doc is not None:
314                if doc is not None and hasattr(doc, "firstChild"):
315                    child = new_doc.getElementsByTagName("SASentry")
316                    for item in child:
317                        doc.firstChild.appendChild(item)
318                else:
319                    doc = new_doc
320        return doc
321
322    def set_qmin(self, qmin):
323        self.qmin = qmin
324        self._qmin_input.SetValue(str(qmin))
325
326    def set_qmax(self, qmax):
327        self.qmax = qmax
328        self._qmax1_input.SetValue(str(qmax[0]))
329        self._qmax2_input.SetValue(str(qmax[1]))
330
331    def set_background(self, bg):
332        self.background = bg
333        self._background_input.SetValue(str(bg))
334        self._calculator.background = bg
335
336    def set_extrapolation_params(self, params=None):
337        """
338        Displays the value of the parameters calculated in the extrapolation
339        """
340        if params is None:
341            # Reset outputs
342            for output in self._extrapolation_outputs.values():
343                output.SetValue('-')
344            return
345        for key, value in params.iteritems():
346            output = self._extrapolation_outputs[key]
347            rounded = self._round_sig_figs(value, 6)
348            output.SetValue(rounded)
349
350
351    def set_extracted_params(self, params=None, reset=False):
352        """
353        Displays the values of the parameters extracted from the Fourier
354        transform
355        """
356        self.extracted_params = params
357        error = False
358        if params is None:
359            if not reset: error = True
360            for output in self._output_boxes.values():
361                output.SetValue('-')
362        else:
363            if len(params) < len(OUTPUT_STRINGS):
364                # Not all parameters were calculated
365                error = True
366            for key, value in params.iteritems():
367                rounded = self._round_sig_figs(value, 6)
368                self._output_boxes[key].SetValue(rounded)
369        if error:
370            msg = 'Not all parameters were able to be calculated'
371            wx.PostEvent(self._manager.parent, StatusEvent(
372                status=msg, info='error'))
373
374    def plot_qrange(self, active=None, leftdown=False):
375        if active is None:
376            active = self._qmin_input
377        wx.PostEvent(self._manager.parent, PlotQrangeEvent(
378            ctrl=[self._qmin_input, self._qmax1_input, self._qmax2_input],
379            active=active, id=IQ_DATA_LABEL, is_corfunc=True,
380            group_id=GROUP_ID_IQ_DATA, leftdown=leftdown))
381
382
383    def _compute_background(self, event=None):
384        """
385        Compute the background level based on the position of the upper q bars
386        """
387        if event is not None:
388            event.Skip()
389        self._on_enter_input()
390        try:
391            bg = self._calculator.compute_background(self.qmax)
392            self.set_background(bg)
393        except Exception as e:
394            msg = "Error computing background level:\n"
395            msg += str(e)
396            wx.PostEvent(self._manager.parent,
397                StatusEvent(status=msg, info="error"))
398
399    def _on_enter_input(self, event=None):
400        """
401        Read values from input boxes and save to memory.
402        """
403        if event is not None: event.Skip()
404        if not self._validate_inputs():
405            return
406        self.qmin = float(self._qmin_input.GetValue())
407        new_qmax1 = float(self._qmax1_input.GetValue())
408        new_qmax2 = float(self._qmax2_input.GetValue())
409        self.qmax = (new_qmax1, new_qmax2)
410        self.background = float(self._background_input.GetValue())
411        self._calculator.background = self.background
412        if event is not None:
413            active_ctrl = event.GetEventObject()
414            if active_ctrl == self._background_input:
415                self._manager.show_data(self._data, IQ_DATA_LABEL,
416                    reset=False, active_ctrl=active_ctrl)
417
418    def _on_click_qrange(self, event=None):
419        if event is None:
420            return
421        event.Skip()
422        if not self._validate_inputs(): return
423        self.plot_qrange(active=event.GetEventObject(),
424            leftdown=event.LeftDown())
425
426    def _validate_inputs(self):
427        """
428        Check that the values for qmin and qmax in the input boxes are valid
429        """
430        if self._data is None:
431            return False
432        qmin_valid = check_float(self._qmin_input)
433        qmax1_valid = check_float(self._qmax1_input)
434        qmax2_valid = check_float(self._qmax2_input)
435        qmax_valid = qmax1_valid and qmax2_valid
436        background_valid = check_float(self._background_input)
437        msg = ""
438        if (qmin_valid and qmax_valid and background_valid):
439            qmin = float(self._qmin_input.GetValue())
440            qmax1 = float(self._qmax1_input.GetValue())
441            qmax2 = float(self._qmax2_input.GetValue())
442            background = float(self._background_input.GetValue())
443            if not qmin > self._data.x.min():
444                msg = "qmin must be greater than the lowest q value"
445                qmin_valid = False
446            elif qmax2 < qmax1:
447                msg = "qmax1 must be less than qmax2"
448                qmax_valid = False
449            elif qmin > qmax1:
450                msg = "qmin must be less than qmax"
451                qmin_valid = False
452            elif background > self._data.y.max():
453                msg = "background must be less than highest I"
454                background_valid = False
455        if not qmin_valid:
456            self._qmin_input.SetBackgroundColour('pink')
457        if not qmax_valid:
458            self._qmax1_input.SetBackgroundColour('pink')
459            self._qmax2_input.SetBackgroundColour('pink')
460        if not background_valid:
461            self._background_input.SetBackgroundColour('pink')
462            if msg != "":
463                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
464        if (qmin_valid and qmax_valid and background_valid):
465            self._qmin_input.SetBackgroundColour(wx.WHITE)
466            self._qmax1_input.SetBackgroundColour(wx.WHITE)
467            self._qmax2_input.SetBackgroundColour(wx.WHITE)
468            self._background_input.SetBackgroundColour(wx.WHITE)
469        self._qmin_input.Refresh()
470        self._qmax1_input.Refresh()
471        self._qmax2_input.Refresh()
472        self._background_input.Refresh()
473        return (qmin_valid and qmax_valid and background_valid)
474
475    def _do_layout(self):
476        """
477        Draw the window content
478        """
479        vbox = wx.GridBagSizer(0,0)
480
481        # I(q) data box
482        databox = wx.StaticBox(self, -1, "I(Q) Data Source")
483        databox_sizer = wx.StaticBoxSizer(databox, wx.VERTICAL)
484
485        file_sizer = wx.GridBagSizer(5, 5)
486
487        y = 0
488
489        file_name_label = wx.StaticText(self, -1, "Name:")
490        file_sizer.Add(file_name_label, (0, 0), (1, 1),
491            wx.LEFT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
492
493        self._data_name_box = OutputTextCtrl(self, -1,
494            size=(300,20))
495        file_sizer.Add(self._data_name_box, (0, 1), (1, 1),
496            wx.CENTER | wx.ADJUST_MINSIZE, 15)
497
498        file_sizer.AddSpacer((1, 25), pos=(0,2))
499        databox_sizer.Add(file_sizer, wx.TOP, 15)
500
501        vbox.Add(databox_sizer, (y, 0), (1, 1),
502            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE | wx.TOP, 15)
503        y += 1
504
505        # Parameters
506        qbox = wx.StaticBox(self, -1, "Input Parameters")
507        qbox_sizer = wx.StaticBoxSizer(qbox, wx.VERTICAL)
508        qbox_sizer.SetMinSize((_STATICBOX_WIDTH, 75))
509
510        q_sizer = wx.GridBagSizer(5, 5)
511
512        # Explanation
513        explanation_txt = ("Corfunc will use all values in the lower range for"
514            " Guinier back extrapolation, and all values in the upper range "
515            "for Porod forward extrapolation.")
516        explanation_label = wx.StaticText(self, -1, explanation_txt,
517            size=(_STATICBOX_WIDTH, 60))
518
519        q_sizer.Add(explanation_label, (0,0), (1,4), wx.LEFT | wx.EXPAND, 5)
520
521        qrange_label = wx.StaticText(self, -1, "Q Range:", size=(50,20))
522        q_sizer.Add(qrange_label, (1,0), (1,1), wx.LEFT | wx.EXPAND, 5)
523
524        # Lower Q Range
525        qmin_label = wx.StaticText(self, -1, "Lower:", size=(50,20))
526        qmin_dash_label = wx.StaticText(self, -1, "-", size=(10,20),
527            style=wx.ALIGN_CENTER_HORIZONTAL)
528
529        qmin_lower = OutputTextCtrl(self, -1, size=(75, 20), value="0.0")
530        self._qmin_input = ModelTextCtrl(self, -1, size=(75, 20),
531                        style=wx.TE_PROCESS_ENTER, name='qmin_input',
532                        text_enter_callback=self._on_enter_input)
533        self._qmin_input.SetToolTipString(("Values with q < qmin will be used "
534            "for Guinier back extrapolation"))
535
536        q_sizer.Add(qmin_label, (2, 0), (1, 1), wx.LEFT | wx.EXPAND, 5)
537        q_sizer.Add(qmin_lower, (2, 1), (1, 1), wx.LEFT, 5)
538        q_sizer.Add(qmin_dash_label, (2, 2), (1, 1), wx.CENTER | wx.EXPAND, 5)
539        q_sizer.Add(self._qmin_input, (2, 3), (1, 1), wx.LEFT, 5)
540
541        # Upper Q range
542        qmax_tooltip = ("Values with qmax1 < q < qmax2 will be used for Porod"
543            " forward extrapolation")
544
545        qmax_label = wx.StaticText(self, -1, "Upper:", size=(50,20))
546        qmax_dash_label = wx.StaticText(self, -1, "-", size=(10,20),
547            style=wx.ALIGN_CENTER_HORIZONTAL)
548
549        self._qmax1_input = ModelTextCtrl(self, -1, size=(75, 20),
550            style=wx.TE_PROCESS_ENTER, name="qmax1_input",
551            text_enter_callback=self._on_enter_input)
552        self._qmax1_input.SetToolTipString(qmax_tooltip)
553        self._qmax2_input = ModelTextCtrl(self, -1, size=(75, 20),
554            style=wx.TE_PROCESS_ENTER, name="qmax2_input",
555            text_enter_callback=self._on_enter_input)
556        self._qmax2_input.SetToolTipString(qmax_tooltip)
557
558        q_sizer.Add(qmax_label, (3, 0), (1, 1), wx.LEFT | wx.EXPAND, 5)
559        q_sizer.Add(self._qmax1_input, (3, 1), (1, 1), wx.LEFT, 5)
560        q_sizer.Add(qmax_dash_label, (3, 2), (1, 1), wx.CENTER | wx.EXPAND, 5)
561        q_sizer.Add(self._qmax2_input, (3,3), (1, 1), wx.LEFT, 5)
562
563        qbox_sizer.Add(q_sizer, wx.TOP, 0)
564
565        vbox.Add(qbox_sizer, (y, 0), (1, 1),
566            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
567        y += 1
568
569        extrapolation_box = wx.StaticBox(self, -1, "Extrapolation Parameters")
570        extrapolation_sizer = wx.StaticBoxSizer(extrapolation_box, wx.VERTICAL)
571        params_sizer = wx.GridBagSizer(5, 5)
572
573        guinier_label = wx.StaticText(self, -1, "Guinier:")
574        params_sizer.Add(guinier_label, (0, 0), (1,1),
575            wx.ALL | wx.EXPAND | wx.ADJUST_MINSIZE, 5)
576
577        a_label = wx.StaticText(self, -1, "A: ")
578        params_sizer.Add(a_label, (1, 0), (1, 1), wx.LEFT | wx.EXPAND, 15)
579
580        a_output = OutputTextCtrl(self, wx.NewId(),
581            value="-", style=wx.ALIGN_CENTER_HORIZONTAL)
582        params_sizer.Add(a_output, (1, 1), (1, 1), wx.RIGHT | wx.EXPAND, 15)
583        self._extrapolation_outputs['A'] = a_output
584
585        b_label = wx.StaticText(self, -1, "B: ")
586        params_sizer.Add(b_label, (2, 0), (1, 1), wx.LEFT | wx.EXPAND, 15)
587
588        b_output = OutputTextCtrl(self, wx.NewId(),
589            value="-", style=wx.ALIGN_CENTER_HORIZONTAL)
590        params_sizer.Add(b_output, (2, 1), (1, 1), wx.RIGHT | wx.EXPAND, 15)
591        self._extrapolation_outputs['B'] = b_output
592
593        porod_label = wx.StaticText(self, -1, "Porod: ")
594        params_sizer.Add(porod_label, (0, 2), (1, 1),
595            wx.ALL | wx.EXPAND | wx.ADJUST_MINSIZE, 5)
596
597        k_label = wx.StaticText(self, -1, "K: ")
598        params_sizer.Add(k_label, (1, 2), (1, 1), wx.LEFT | wx.EXPAND, 15)
599
600        k_output = OutputTextCtrl(self, wx.NewId(),
601            value="-", style=wx.ALIGN_CENTER_HORIZONTAL)
602        params_sizer.Add(k_output, (1, 3), (1, 1), wx.RIGHT | wx.EXPAND, 15)
603        self._extrapolation_outputs['K'] = k_output
604
605        sigma_label = wx.StaticText(self, -1, u'\u03C3: ')
606        params_sizer.Add(sigma_label, (2, 2), (1, 1), wx.LEFT | wx.EXPAND, 15)
607
608        sigma_output = OutputTextCtrl(self, wx.NewId(),
609            value="-", style=wx.ALIGN_CENTER_HORIZONTAL)
610        params_sizer.Add(sigma_output, (2, 3), (1, 1), wx.RIGHT | wx.EXPAND, 15)
611        self._extrapolation_outputs['sigma'] = sigma_output
612
613        bg_label = wx.StaticText(self, -1, "Bg: ")
614        params_sizer.Add(bg_label, (3, 2), (1, 1), wx.LEFT | wx.EXPAND, 15)
615
616        self._background_input = ModelTextCtrl(self, -1, value="0.0",
617            style=wx.TE_PROCESS_ENTER | wx.TE_CENTRE, name='background_input',
618            text_enter_callback=self._on_enter_input)
619        self._background_input.SetToolTipString(("A background value to "
620            "subtract from all intensity values"))
621        params_sizer.Add(self._background_input, (3, 3), (1, 1), wx.RIGHT | wx.EXPAND, 15)
622
623        background_button = wx.Button(self, wx.NewId(), "Calculate Bg",
624            size=(75, -1))
625        background_button.Bind(wx.EVT_BUTTON, self._compute_background)
626        params_sizer.Add(background_button, (4,3), (1, 1), wx.EXPAND | wx.RIGHT, 15)
627
628        extrapolation_sizer.Add(params_sizer)
629        vbox.Add(extrapolation_sizer, (y, 0), (1, 1),
630            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
631        y += 1
632
633        # Transform type
634        transform_box = wx.StaticBox(self, -1, "Transform Type")
635        transform_sizer = wx.StaticBoxSizer(transform_box, wx.VERTICAL)
636
637        radio_sizer = wx.GridBagSizer(5,5)
638
639        fourier_btn = wx.RadioButton(self, -1, "Fourier", name='fourier',
640            style=wx.RB_GROUP)
641        hilbert_btn = wx.RadioButton(self, -1, "Hilbert", name='hilbert')
642
643        fourier_btn.Bind(wx.EVT_RADIOBUTTON, self.radio_changed)
644        hilbert_btn.Bind(wx.EVT_RADIOBUTTON, self.radio_changed)
645
646        radio_sizer.Add(fourier_btn, (0,0), (1,1), wx.LEFT | wx.EXPAND)
647        radio_sizer.Add(hilbert_btn, (0,1), (1,1), wx.RIGHT | wx.EXPAND)
648
649        transform_sizer.Add(radio_sizer, wx.TOP, 0)
650        vbox.Add(transform_sizer, (y, 0), (1, 1),
651            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
652        y += 1
653
654        # Output data
655        outputbox = wx.StaticBox(self, -1, "Output Parameters")
656        outputbox_sizer = wx.StaticBoxSizer(outputbox, wx.VERTICAL)
657
658        output_sizer = wx.GridBagSizer(5, 5)
659
660        self._output_boxes = dict()
661        i = 0
662        for key, value in OUTPUT_STRINGS.iteritems():
663            # Create a label and a text box for each poperty
664            label = wx.StaticText(self, -1, value)
665            output_box = OutputTextCtrl(self, wx.NewId(),
666                value="-", style=wx.ALIGN_CENTER_HORIZONTAL)
667            # Save the ID of each of the text boxes for accessing after the
668            # output data has been calculated
669            self._output_boxes[key] = output_box
670            output_sizer.Add(label, (i, 0), (1, 1), wx.LEFT | wx.EXPAND, 15)
671            output_sizer.Add(output_box, (i, 2), (1, 1),
672                wx.RIGHT | wx.EXPAND, 15)
673            i += 1
674
675        outputbox_sizer.Add(output_sizer, wx.TOP, 0)
676
677        vbox.Add(outputbox_sizer, (y, 0), (1, 1),
678            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
679        y += 1
680
681        # Controls
682        controlbox = wx.StaticBox(self, -1, "Controls")
683        controlbox_sizer = wx.StaticBoxSizer(controlbox, wx.VERTICAL)
684
685        controls_sizer = wx.BoxSizer(wx.VERTICAL)
686
687        self._extrapolate_btn = wx.Button(self, wx.NewId(), "Extrapolate")
688        self._transform_btn = wx.Button(self, wx.NewId(), "Transform")
689        self._extract_btn = wx.Button(self, wx.NewId(), "Compute Parameters")
690        help_btn = wx.Button(self, -1, "HELP")
691
692        self._transform_btn.Disable()
693        self._extract_btn.Disable()
694
695        self._extrapolate_btn.Bind(wx.EVT_BUTTON, self.compute_extrapolation)
696        self._transform_btn.Bind(wx.EVT_BUTTON, self.compute_transform)
697        self._extract_btn.Bind(wx.EVT_BUTTON, self.extract_parameters)
698        help_btn.Bind(wx.EVT_BUTTON, self.on_help)
699
700        controls_sizer.Add(self._extrapolate_btn, wx.CENTER | wx.EXPAND)
701        controls_sizer.Add(self._transform_btn, wx.CENTER | wx.EXPAND)
702        controls_sizer.Add(self._extract_btn, wx.CENTER | wx.EXPAND)
703        controls_sizer.Add(help_btn, wx.CENTER | wx.EXPAND)
704
705        controlbox_sizer.Add(controls_sizer, wx.TOP | wx.EXPAND, 0)
706        vbox.Add(controlbox_sizer, (y, 0), (1, 1),
707            wx.LEFT | wx.RIGHT | wx.EXPAND | wx.ADJUST_MINSIZE, 15)
708
709
710        self.SetSizer(vbox)
711
712    def _disable_inputs(self):
713        """
714        Disable all input fields
715        """
716        self._qmin_input.Disable()
717        self._qmax1_input.Disable()
718        self._qmax2_input.Disable()
719        self._background_input.Disable()
720        self._extrapolate_btn.Disable()
721
722    def _enable_inputs(self):
723        """
724        Enable all input fields
725        """
726        self._qmin_input.Enable()
727        self._qmax1_input.Enable()
728        self._qmax2_input.Enable()
729        self._background_input.Enable()
730        self._extrapolate_btn.Enable()
731
732    def _round_sig_figs(self, x, sigfigs):
733        """
734        Round a number to a given number of significant figures.
735
736        :param x: The value to round
737        :param sigfigs: How many significant figures to round to
738        :return rounded_str: x rounded to the given number of significant
739            figures, as a string
740        """
741        rounded_str = ""
742        try:
743            # Index of first significant digit
744            significant_digit = -int(np.floor(np.log10(np.abs(x))))
745
746            if np.abs(significant_digit > 4):
747                # Use scientific notation if x > 1e5 or x < 1e4
748                rounded_str = "{1:.{0}E}".format(sigfigs-1, x)
749            else:
750                # Format as a standard decimal
751                # Number of digits required for correct number of sig figs
752                digits = significant_digit + (sigfigs - 1)
753                rounded = np.round(x, decimals=digits)
754                rounded_str = "{1:.{0}f}".format(sigfigs -1  + significant_digit,
755                    rounded)
756        except:
757            # Method for finding significant_digit fails if x is 0 (since log10(0)=inf)
758            if x == 0.0:
759                rounded_str = "0.0"
760            else:
761                rounded_str = "-"
762
763        return rounded_str
Note: See TracBrowser for help on using the repository browser.