source: sasview/src/sas/sasgui/perspectives/fitting/basepage.py @ cf2e6b4

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 cf2e6b4 was cf2e6b4, checked in by wojciech, 7 years ago

Fixing commenrts to the code

  • Property mode set to 100644
File size: 142.7 KB
Line 
1"""
2Base Page for fitting
3"""
4import sys
5import os
6import wx
7import numpy
8import time
9import copy
10import math
11import json
12import logging
13import traceback
14
15from collections import defaultdict
16from wx.lib.scrolledpanel import ScrolledPanel
17
18from sasmodels.weights import MODELS as POLYDISPERSITY_MODELS
19
20from sas.sasgui.guiframe.panel_base import PanelBase
21from sas.sasgui.guiframe.utils import format_number, check_float, IdList, \
22    check_int
23from sas.sasgui.guiframe.events import PanelOnFocusEvent
24from sas.sasgui.guiframe.events import StatusEvent
25from sas.sasgui.guiframe.events import AppendBookmarkEvent
26from sas.sasgui.guiframe.dataFitting import Data2D
27from sas.sasgui.guiframe.dataFitting import Data1D
28from sas.sasgui.guiframe.dataFitting import check_data_validity
29from sas.sasgui.guiframe.gui_style import GUIFRAME_ID
30from sas.sascalc.dataloader.data_info import Detector
31from sas.sascalc.dataloader.data_info import Source
32from sas.sasgui.perspectives.fitting.pagestate import PageState
33from sas.sasgui.guiframe.CategoryInstaller import CategoryInstaller
34from sas.sasgui.guiframe.documentation_window import DocumentationWindow
35
36
37(PageInfoEvent, EVT_PAGE_INFO) = wx.lib.newevent.NewEvent()
38(PreviousStateEvent, EVT_PREVIOUS_STATE) = wx.lib.newevent.NewEvent()
39(NextStateEvent, EVT_NEXT_STATE) = wx.lib.newevent.NewEvent()
40
41_BOX_WIDTH = 76
42_QMIN_DEFAULT = 0.0005
43_QMAX_DEFAULT = 0.5
44_NPTS_DEFAULT = 50
45# Control panel width
46if sys.platform.count("win32") > 0:
47    PANEL_WIDTH = 450
48    FONT_VARIANT = 0
49    ON_MAC = False
50else:
51    PANEL_WIDTH = 500
52    FONT_VARIANT = 1
53    ON_MAC = True
54
55class BasicPage(ScrolledPanel, PanelBase):
56    """
57    This class provide general structure of  fitpanel page
58    """
59    # Internal name for the AUI manager
60    window_name = "Fit Page"
61    # Title to appear on top of the window
62    window_caption = "Fit Page "
63
64    # These two buttons have specific IDs since they seem to be created more
65    # frequently than they need to.  In particular, set_dispers_sizer() is
66    # called by _on_select_model
67    ID_BOOKMARK = wx.NewId()
68    ID_DISPERSER_HELP = wx.NewId()
69    _id_pool = IdList()
70
71    def __init__(self, parent, color='blue', **kwargs):
72        """
73        """
74        ScrolledPanel.__init__(self, parent, **kwargs)
75        PanelBase.__init__(self, parent)
76        self.SetupScrolling()
77        # Set window's font size
78        self.SetWindowVariant(variant=FONT_VARIANT)
79        self.SetBackgroundColour(color)
80
81        self._ids = iter(self._id_pool)
82        # parent of the page
83        self.parent = parent
84        # manager is the fitting plugin
85        # owner of the page (fitting plugin)
86        self.event_owner = None
87        # current model
88        self.model = None
89        self.m_name = None
90        self.index_model = None
91        self.panel = None
92        # data
93        self.data = None
94        # list of available data
95        self.data_list = []
96        self.mask = None
97        self.uid = wx.NewId()
98        self.graph_id = None
99        # Q range for data set
100        self.qmin_data_set = numpy.inf
101        self.qmax_data_set = None
102        self.npts_data_set = 0
103        # Q range
104        self.qmin = None
105        self.qmax = None
106        self.qmax_x = _QMAX_DEFAULT
107        self.qmin_x = _QMIN_DEFAULT
108        self.npts_x = _NPTS_DEFAULT
109        # total number of point: float
110        self.npts = None
111        self.num_points = None
112        # smear default
113        self.current_smearer = None
114        # 2D smear accuracy default
115        self.smear2d_accuracy = 'Low'
116        # slit smear:
117        self.dxl = None
118        self.dxw = None
119        # pinhole smear
120        self.dx_min = None
121        self.dx_max = None
122        # smear attrbs
123        self.enable_smearer = None
124        self.disable_smearer = None
125        self.pinhole_smearer = None
126        self.slit_smearer = None
127        # weight attrbs
128        self.dI_noweight = None
129        self.dI_didata = None
130        self.dI_sqrdata = None
131        self.dI_idata = None
132        # other attrbs
133        self.dq_l = None
134        self.dq_r = None
135        self.tcChi = None
136        self.disp_box = None
137        self.model_disp = None
138        self.Npts_fit = None
139        self.Npts_total = None
140        self.theory_qmin = None
141        self.theory_qmax = None
142        self.theory_qmin_x = None
143        self.theory_qmax_x = None
144        self.btEditMask = None
145        self.btFit = None
146        self.sld_axes = None
147        self.multi_factor = None
148
149        self.disp_cb_dict = {}
150
151        # self.state = PageState(parent=parent)
152        # dictionary containing list of models
153        self.model_list_box = {}
154
155        # Data member to store the dispersion object created
156        self._disp_obj_dict = {}
157        # selected parameters to apply dispersion
158        self.disp_cb_dict = {}
159        # smearer object
160        self.enable2D = False
161        self._has_magnetic = False
162        self.magnetic_on = False
163        self.is_mac = ON_MAC
164        self.formfactorbox = None
165        self.structurebox = None
166        self.categorybox = None
167        # list of model parameters. each item must have same length
168        # each item related to a given parameters
169        # [cb state, name, value, "+/-", error of fit, min, max , units]
170        self.parameters = []
171        # non-fittable parameter whose value is astring
172        self.str_parameters = []
173        # list of parameters to fit , must be like self.parameters
174        self.param_toFit = []
175        # list of looking like parameters but with non fittable parameters info
176        self.fixed_param = []
177        # list of looking like parameters but with  fittable parameters info
178        self.fittable_param = []
179        # list of dispersion parameters
180        self.disp_list = []
181        self.disp_name = ""
182
183        # list of orientation parameters
184        self.orientation_params = []
185        self.orientation_params_disp = []
186#       Self.model should ALWAYS be None here.  It was set to none above in
187#       this long init setting.  no obvious function call in between setting
188#       and this - commenting out on 4/8/2014 by PDB.  Remove once clear
189#       it is pointless.
190#        if self.model is not None:
191#            self.disp_list = self.model.getDispParamList()
192        self.temp_multi_functional = False
193        # enable model 2D draw
194        self.enable2D = False
195        # check that the fit range is correct to plot the model again
196        self.fitrange = True
197        # Create memento to save the current state
198        self.state = PageState(parent=self.parent,
199                               model=self.model, data=self.data)
200        # flag to determine if state has change
201        self.state_change = False
202        # save customized array
203        self.values = {}   # type: Dict[str, List[float, ...]]
204        self.weights = {}   # type: Dict[str, List[float, ...]]
205        # retrieve saved state
206        self.number_saved_state = 0
207        # dictionary of saved state
208        self.saved_states = {}
209        # Create context menu for page
210        self.popUpMenu = wx.Menu()
211
212        wx_id = self._ids.next()
213        self._keep = wx.MenuItem(self.popUpMenu, wx_id, "Add bookmark",
214                                 " Keep the panel status to recall it later")
215        self.popUpMenu.AppendItem(self._keep)
216        self._keep.Enable(False)
217        self._set_bookmark_flag(False)
218        self._set_save_flag(False)
219        wx.EVT_MENU(self, wx_id, self.on_bookmark)
220        self.popUpMenu.AppendSeparator()
221
222        # Default locations
223        self._default_save_location = os.getcwd()
224        # save initial state on context menu
225        # self.onSave(event=None)
226        self.Bind(wx.EVT_CONTEXT_MENU, self.onContextMenu)
227
228        # bind key event
229        self.Bind(wx.EVT_LEFT_DOWN, self.on_left_down)
230
231        # create the basic structure of the panel with empty sizer
232        self.define_page_structure()
233        # drawing Initial dispersion parameters sizer
234        self.set_dispers_sizer()
235
236        # layout
237        self.set_layout()
238
239    def set_index_model(self, index):
240        """
241        Index related to this page
242        """
243        self.index_model = index
244
245    def create_default_data(self):
246        """
247        Given the user selection, creates a 1D or 2D data
248        Only when the page is on theory mode.
249        """
250        if not hasattr(self, "model_view"):
251            return
252        toggle_mode_on = self.model_view.IsEnabled()
253        if toggle_mode_on:
254            if self.enable2D and not check_data_validity(self.data):
255                self._create_default_2d_data()
256            else:
257                if self.pointsbox.GetValue():
258                    self._create_log_1d_data()
259                else:
260                    self._create_default_1d_data()
261
262            if self.model is not None:
263                if not self.data.is_data:
264                    self._manager.page_finder[self.uid].set_fit_data(
265                        data=[self.data])
266            self.on_smear_helper(update=True)
267            self.state.enable_smearer = self.enable_smearer.GetValue()
268            self.state.disable_smearer = self.disable_smearer.GetValue()
269            self.state.pinhole_smearer = self.pinhole_smearer.GetValue()
270            self.state.slit_smearer = self.slit_smearer.GetValue()
271
272    def _create_default_1d_data(self):
273        """
274        Create default data for fitting perspective
275        Only when the page is on theory mode.
276        :warning: This data is never plotted.
277
278        """
279        x = numpy.linspace(start=self.qmin_x, stop=self.qmax_x,
280                           num=self.npts_x, endpoint=True)
281        self.data = Data1D(x=x)
282        self.data.xaxis('\\rm{Q}', "A^{-1}")
283        self.data.yaxis('\\rm{Intensity}', "cm^{-1}")
284        self.data.is_data = False
285        self.data.id = str(self.uid) + " data"
286        self.data.group_id = str(self.uid) + " Model1D"
287
288    def _create_log_1d_data(self):
289        """
290        Create log-spaced data for fitting perspective
291        Only when the page is on theory mode.
292        :warning: This data is never plotted.
293
294        """
295        if self.qmin_x >= 1.e-10:
296            qmin = numpy.log10(self.qmin_x)
297        else:
298            qmin = -10.
299
300        if self.qmax_x <= 1.e10:
301            qmax = numpy.log10(self.qmax_x)
302        else:
303            qmax = 10.
304
305        x = numpy.logspace(start=qmin, stop=qmax,
306                           num=self.npts_x, endpoint=True, base=10.0)
307        self.data = Data1D(x=x)
308        self.data.xaxis('\\rm{Q}', "A^{-1}")
309        self.data.yaxis('\\rm{Intensity}', "cm^{-1}")
310        self.data.is_data = False
311        self.data.id = str(self.uid) + " data"
312        self.data.group_id = str(self.uid) + " Model1D"
313
314    def _create_default_2d_data(self):
315        """
316        Create 2D data by default
317        Only when the page is on theory mode.
318        :warning: This data is never plotted.
319        """
320        self.data = Data2D()
321        qmax = self.qmax_x / math.sqrt(2)
322        self.data.xaxis('\\rm{Q_{x}}', 'A^{-1}')
323        self.data.yaxis('\\rm{Q_{y}}', 'A^{-1}')
324        self.data.is_data = False
325        self.data.id = str(self.uid) + " data"
326        self.data.group_id = str(self.uid) + " Model2D"
327        # Default values
328        self.data.detector.append(Detector())
329        index = len(self.data.detector) - 1
330        self.data.detector[index].distance = 8000   # mm
331        self.data.source.wavelength = 6             # A
332        self.data.detector[index].pixel_size.x = 5  # mm
333        self.data.detector[index].pixel_size.y = 5  # mm
334        self.data.detector[index].beam_center.x = qmax
335        self.data.detector[index].beam_center.y = qmax
336        xmax = qmax
337        xmin = -qmax
338        ymax = qmax
339        ymin = -qmax
340        qstep = self.npts_x
341
342        x = numpy.linspace(start=xmin, stop=xmax, num=qstep, endpoint=True)
343        y = numpy.linspace(start=ymin, stop=ymax, num=qstep, endpoint=True)
344        # use data info instead
345        new_x = numpy.tile(x, (len(y), 1))
346        new_y = numpy.tile(y, (len(x), 1))
347        new_y = new_y.swapaxes(0, 1)
348        # all data reuire now in 1d array
349        qx_data = new_x.flatten()
350        qy_data = new_y.flatten()
351        q_data = numpy.sqrt(qx_data * qx_data + qy_data * qy_data)
352        # set all True (standing for unmasked) as default
353        mask = numpy.ones(len(qx_data), dtype=bool)
354        # store x and y bin centers in q space
355        x_bins = x
356        y_bins = y
357
358        self.data.source = Source()
359        self.data.data = numpy.ones(len(mask))
360        self.data.err_data = numpy.ones(len(mask))
361        self.data.qx_data = qx_data
362        self.data.qy_data = qy_data
363        self.data.q_data = q_data
364        self.data.mask = mask
365        self.data.x_bins = x_bins
366        self.data.y_bins = y_bins
367        # max and min taking account of the bin sizes
368        self.data.xmin = xmin
369        self.data.xmax = xmax
370        self.data.ymin = ymin
371        self.data.ymax = ymax
372
373    def on_set_focus(self, event):
374        """
375        On Set Focus, update guimanger and menu
376        """
377        if self._manager is not None:
378            wx.PostEvent(self._manager.parent, PanelOnFocusEvent(panel=self))
379            self.on_tap_focus()
380
381    def on_tap_focus(self):
382        """
383        Update menu1 on cliking the page tap
384        """
385        if self._manager.menu1 is not None:
386            chain_menu = self._manager.menu1.FindItemById(
387                                                   self._manager.id_reset_flag)
388            chain_menu.Enable(self.batch_on)
389            sim_menu = self._manager.menu1.FindItemById(self._manager.id_simfit)
390            flag = self.data.is_data\
391                            and (self.model is not None)
392            sim_menu.Enable(not self.batch_on and flag)
393            batch_menu = \
394                    self._manager.menu1.FindItemById(self._manager.id_batchfit)
395            batch_menu.Enable(self.batch_on and flag)
396
397    def onContextMenu(self, event):
398        """
399        Retrieve the state selected state
400        """
401        pos = event.GetPosition()
402        pos = self.ScreenToClient(pos)
403        self.PopupMenu(self.popUpMenu, pos)
404
405    def onUndo(self, event):
406        """
407        Cancel the previous action
408        """
409        event = PreviousStateEvent(page=self)
410        wx.PostEvent(self.parent, event)
411
412    def onRedo(self, event):
413        """
414        Restore the previous action cancelled
415        """
416        event = NextStateEvent(page=self)
417        wx.PostEvent(self.parent, event)
418
419    def define_page_structure(self):
420        """
421        Create empty sizer for a panel
422        """
423        self.vbox = wx.BoxSizer(wx.VERTICAL)
424        self.sizer0 = wx.BoxSizer(wx.VERTICAL)
425        self.sizer1 = wx.BoxSizer(wx.VERTICAL)
426        self.sizer2 = wx.BoxSizer(wx.VERTICAL)
427        self.sizer3 = wx.BoxSizer(wx.VERTICAL)
428        self.sizer4 = wx.BoxSizer(wx.VERTICAL)
429        self.sizer5 = wx.BoxSizer(wx.VERTICAL)
430        self.sizer6 = wx.BoxSizer(wx.VERTICAL)
431
432        self.sizer0.SetMinSize((PANEL_WIDTH, -1))
433        self.sizer1.SetMinSize((PANEL_WIDTH, -1))
434        self.sizer2.SetMinSize((PANEL_WIDTH, -1))
435        self.sizer3.SetMinSize((PANEL_WIDTH, -1))
436        self.sizer4.SetMinSize((PANEL_WIDTH, -1))
437        self.sizer5.SetMinSize((PANEL_WIDTH, -1))
438        self.sizer6.SetMinSize((PANEL_WIDTH, -1))
439
440        self.vbox.Add(self.sizer0)
441        self.vbox.Add(self.sizer1)
442        self.vbox.Add(self.sizer2)
443        self.vbox.Add(self.sizer3)
444        self.vbox.Add(self.sizer4)
445        self.vbox.Add(self.sizer5)
446        self.vbox.Add(self.sizer6)
447
448    def set_layout(self):
449        """
450        layout
451        """
452        self.vbox.Layout()
453        self.vbox.Fit(self)
454        self.SetSizer(self.vbox)
455        self.Centre()
456
457    def set_owner(self, owner):
458        """
459        set owner of fitpage
460
461        :param owner: the class responsible of plotting
462
463        """
464        self.event_owner = owner
465        self.state.event_owner = owner
466
467    def get_state(self):
468        """
469        return the current page state
470        """
471        return self.state
472
473    def get_data(self):
474        """
475        return the current data
476        """
477        return self.data
478
479    def get_data_list(self):
480        """
481        return the current data
482        """
483        return self.data_list
484
485    def set_manager(self, manager):
486        """
487        set panel manager
488
489        :param manager: instance of plugin fitting
490
491        """
492        self._manager = manager
493        self.state.manager = manager
494
495    def populate_box(self, model_dict):
496        """
497        Store list of model
498
499        :param model_dict: dictionary containing list of models
500
501        """
502        self.model_list_box = model_dict
503        self.state.model_list_box = self.model_list_box
504        self.initialize_combox()
505
506    def set_model_dictionary(self, model_dict):
507        """
508        Store a dictionary linking model name -> model object
509
510        :param model_dict: dictionary containing list of models
511        """
512        self.model_dict = model_dict
513
514    def initialize_combox(self):
515        """
516        put default value in the combo box
517        """
518        if self.model_list_box is not None and len(self.model_list_box) > 0:
519            self._populate_box(self.structurebox,
520                               self.model_list_box["Structure Factors"])
521            self.structurebox.Insert("None", 0, None)
522            self.structurebox.SetSelection(0)
523            self.structurebox.Hide()
524            self.text2.Hide()
525            self.structurebox.Disable()
526            self.text2.Disable()
527
528    def set_dispers_sizer(self):
529        """
530        fill sizer containing dispersity info
531        """
532        # print "==== entering set_dispers_sizer ==="
533        self.sizer4.Clear(True)
534        name = "Polydispersity and Orientational Distribution"
535        box_description = wx.StaticBox(self, wx.ID_ANY, name)
536        box_description.SetForegroundColour(wx.BLUE)
537        boxsizer1 = wx.StaticBoxSizer(box_description, wx.VERTICAL)
538        # ----------------------------------------------------
539        self.disable_disp = wx.RadioButton(self, wx.ID_ANY, 'Off', (10, 10),
540                                           style=wx.RB_GROUP)
541        self.enable_disp = wx.RadioButton(self, wx.ID_ANY, 'On', (10, 30))
542        # best size for MAC and PC
543        if ON_MAC:
544            size_q = (30, 20)
545        else:
546            size_q = (20, 15)
547        self.disp_help_bt = wx.Button(self, self.ID_DISPERSER_HELP, '?',
548                                      style=wx.BU_EXACTFIT,
549                                      size=size_q)
550        self.disp_help_bt.Bind(wx.EVT_BUTTON, self.on_pd_help_clicked,
551                               id=self.disp_help_bt.GetId())
552        self.disp_help_bt.SetToolTipString("Help for polydispersion.")
553
554        self.Bind(wx.EVT_RADIOBUTTON, self._set_dipers_Param,
555                  id=self.disable_disp.GetId())
556        self.Bind(wx.EVT_RADIOBUTTON, self._set_dipers_Param,
557                  id=self.enable_disp.GetId())
558        # MAC needs SetValue
559        self.disable_disp.SetValue(True)
560        sizer_dispersion = wx.BoxSizer(wx.HORIZONTAL)
561        sizer_dispersion.Add((20, 20))
562        name = ""  # Polydispersity and \nOrientational Distribution "
563        sizer_dispersion.Add(wx.StaticText(self, wx.ID_ANY, name))
564        sizer_dispersion.Add(self.enable_disp)
565        sizer_dispersion.Add((20, 20))
566        sizer_dispersion.Add(self.disable_disp)
567        sizer_dispersion.Add((25, 20))
568        sizer_dispersion.Add(self.disp_help_bt)
569
570        # fill a sizer for dispersion
571        boxsizer1.Add(sizer_dispersion, 0,
572                      wx.TOP|wx.BOTTOM|wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE,
573                      border=5)
574        self.sizer4_4 = wx.GridBagSizer(6, 5)
575
576        boxsizer1.Add(self.sizer4_4)
577        # -----------------------------------------------------
578        self.sizer4.Add(boxsizer1, 0, wx.EXPAND | wx.ALL, 10)
579        self.sizer4_4.Layout()
580        self.sizer4.Layout()
581        self.Layout()
582
583        self.Refresh()
584        # saving the state of enable dispersity button
585        self.state.enable_disp = self.enable_disp.GetValue()
586        self.state.disable_disp = self.disable_disp.GetValue()
587        self.SetupScrolling()
588
589    def onResetModel(self, event):
590        """
591        Reset model state
592        """
593        menu = event.GetEventObject()
594        # post help message for the selected model
595        msg = menu.GetHelpString(event.GetId())
596        msg += " reloaded"
597        wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
598        self.Show(False)
599        name = menu.GetLabel(event.GetId())
600        self._on_select_model_helper()
601        if self.model is not None:
602            self.m_name = self.model.name
603        if name in self.saved_states.keys():
604            previous_state = self.saved_states[name]
605            # reset state of checkbox,textcrtl  and  regular parameters value
606
607            self.reset_page(previous_state)
608        self.state.m_name = self.m_name
609        self.Show(True)
610
611    def on_preview(self, event):
612        """
613        Report the current fit results
614        """
615        # Get plot image from plotpanel
616        images, canvases = self.get_images()
617        # get the report dialog
618        self.state.report(images, canvases)
619
620    def on_save(self, event):
621        """
622        Save the current state into file
623        """
624        self.save_current_state()
625        new_state = self.state.clone()
626        # Ask the user the location of the file to write to.
627        path = None
628        if self.parent is not None:
629            self._default_save_location = \
630                        self._manager.parent._default_save_location
631        dlg = wx.FileDialog(self, "Choose a file", self._default_save_location,
632                            self.window_caption, "*.fitv", wx.SAVE)
633
634        if dlg.ShowModal() == wx.ID_OK:
635            path = dlg.GetPath()
636            self._default_save_location = os.path.dirname(path)
637            self._manager.parent._default_save_location = \
638                self._default_save_location
639        else:
640            return None
641        # MAC always needs the extension for saving
642        extens = ".fitv"
643        # Make sure the ext included in the file name
644        fName = os.path.splitext(path)[0] + extens
645        # the manager write the state into file
646        self._manager.save_fit_state(filepath=fName, fitstate=new_state)
647        return new_state
648
649    def on_copy(self, event):
650        """
651        Copy Parameter values to the clipboad
652        """
653        if event is not None:
654            event.Skip()
655        # It seems MAC needs wxCallAfter
656        if event.GetId() == GUIFRAME_ID.COPYEX_ID:
657            print "copy excel"
658            wx.CallAfter(self.get_copy_excel)
659        elif event.GetId() == GUIFRAME_ID.COPYLAT_ID:
660            print "copy latex"
661            wx.CallAfter(self.get_copy_latex)
662        else:
663            wx.CallAfter(self.get_copy)
664
665    def on_paste(self, event):
666        """
667        Paste Parameter values to the panel if possible
668        """
669        # if event is not None:
670        #    event.Skip()
671        # It seems MAC needs wxCallAfter for the setvalues
672        # for multiple textctrl items, otherwise it tends to crash once a while
673        wx.CallAfter(self.get_paste)
674        # messages depending on the flag
675        # self._copy_info(True)
676
677    def _copy_info(self, flag):
678        """
679        Send event dpemding on flag
680
681        : Param flag: flag that distinguish event
682        """
683        # messages depending on the flag
684        if flag is None:
685            msg = " Parameter values are copied to the clipboard..."
686            infor = 'warning'
687        elif flag:
688            msg = " Parameter values are pasted from the clipboard..."
689            infor = "warning"
690        else:
691            msg = "Error occurred: "
692            msg += "No valid parameter values to paste from the clipboard..."
693            infor = "warning"
694        # inform msg to wx
695        wx.PostEvent(self._manager.parent,
696                     StatusEvent(status=msg, info=infor))
697
698    def _get_time_stamp(self):
699        """
700        return time and date stings
701        """
702        # date and time
703        year, month, day, hour, minute, second, _, _, _ = time.localtime()
704        current_time = str(hour) + ":" + str(minute) + ":" + str(second)
705        current_date = str(month) + "/" + str(day) + "/" + str(year)
706        return current_time, current_date
707
708    def on_bookmark(self, event):
709        """
710        save history of the data and model
711        """
712        if self.model is None:
713            msg = "Can not bookmark; Please select Data and Model first..."
714            wx.MessageBox(msg, 'Info')
715            return
716        self.save_current_state()
717        new_state = self.state.clone()
718        # Add model state on context menu
719        self.number_saved_state += 1
720        current_time, current_date = self._get_time_stamp()
721        # name= self.model.name+"[%g]"%self.number_saved_state
722        name = "Fitting: %g]" % self.number_saved_state
723        name += self.model.__class__.__name__
724        name += "bookmarked at %s on %s" % (current_time, current_date)
725        self.saved_states[name] = new_state
726
727        # Add item in the context menu
728        msg = "Model saved at %s on %s" % (current_time, current_date)
729        # post help message for the selected model
730        msg += " Saved! right click on this page to retrieve this model"
731        wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
732
733        self.popUpMenu.Append(self.ID_BOOKMARK, name, str(msg))
734        wx.EVT_MENU(self, self.ID_BOOKMARK, self.onResetModel)
735        wx.PostEvent(self._manager.parent,
736                     AppendBookmarkEvent(title=name,
737                                         hint=str(msg),
738                                         handler=self._back_to_bookmark))
739
740    def _back_to_bookmark(self, event):
741        """
742        Back to bookmark
743        """
744        self._manager.on_perspective(event)
745        self.onResetModel(event)
746        self._draw_model()
747
748    def onSetFocus(self, evt):
749        """
750        highlight the current textcrtl and hide the error text control shown
751        after fitting
752        """
753        return
754
755    def read_file(self, path):
756        """
757        Read two columns file
758
759        :param path: the path to the file to read
760
761        """
762        try:
763            if path is None:
764                status = " Selected Distribution was not loaded: %s" % path
765                wx.PostEvent(self._manager.parent,
766                             StatusEvent(status=status))
767                return None, None
768            input_f = open(path, 'r')
769            buff = input_f.read()
770            lines = buff.split('\n')
771            input_f.close()
772            angles = []
773            weights = []
774            for line in lines:
775                toks = line.split()
776                try:
777                    angle = float(toks[0])
778                    weight = float(toks[1])
779                    angles.append(angle)
780                    weights.append(weight)
781                except Exception:
782                    # Skip non-data lines
783                    logging.error(traceback.format_exc())
784            return numpy.array(angles), numpy.array(weights)
785        except:
786            raise
787
788    def createMemento(self):
789        """
790        return the current state of the page
791        """
792        return self.state.clone()
793
794    def save_current_state(self):
795        """
796        Store current state
797        """
798        # save model option
799        if self.model is not None:
800            self.disp_list = self.model.getDispParamList()
801            self.state.disp_list = copy.deepcopy(self.disp_list)
802            self.state.model = self.model.clone()
803
804            # model combobox: complex code because of mac's silent error
805            if self.structurebox is not None:
806                if self.structurebox.IsShown():
807                    self.state.structurecombobox = 'None'
808                    s_select = self.structurebox.GetSelection()
809                    if s_select > 0:
810                        self.state.structurecombobox = \
811                            self.structurebox.GetString(s_select)
812            if self.formfactorbox is not None:
813                f_select = self.formfactorbox.GetSelection()
814                if f_select > 0:
815                    self.state.formfactorcombobox = \
816                        self.formfactorbox.GetString(f_select)
817        if self.categorybox is not None:
818            cb_select = self.categorybox.GetSelection()
819            if cb_select > 0:
820                self.state.categorycombobox = \
821                    self.categorybox.GetString(cb_select)
822
823        self.state.enable2D = copy.deepcopy(self.enable2D)
824        self.state.values = copy.deepcopy(self.values)
825        self.state.weights = copy.deepcopy(self.weights)
826        # save data
827        self.state.data = copy.deepcopy(self.data)
828        self.state.qmax_x = self.qmax_x
829        self.state.qmin_x = self.qmin_x
830        self.state.dI_noweight = copy.deepcopy(self.dI_noweight.GetValue())
831        self.state.dI_didata = copy.deepcopy(self.dI_didata.GetValue())
832        self.state.dI_sqrdata = copy.deepcopy(self.dI_sqrdata.GetValue())
833        self.state.dI_idata = copy.deepcopy(self.dI_idata.GetValue())
834        self.state.dq_l = self.dq_l
835        self.state.dq_r = self.dq_r
836        if hasattr(self, "enable_disp"):
837            self.state.enable_disp = self.enable_disp.GetValue()
838            self.state.disable_disp = self.disable_disp.GetValue()
839
840        self.state.smearer = copy.deepcopy(self.current_smearer)
841        if hasattr(self, "enable_smearer"):
842            self.state.enable_smearer = \
843                                copy.deepcopy(self.enable_smearer.GetValue())
844            self.state.disable_smearer = \
845                                copy.deepcopy(self.disable_smearer.GetValue())
846
847        self.state.pinhole_smearer = \
848                                copy.deepcopy(self.pinhole_smearer.GetValue())
849        self.state.dx_max = copy.deepcopy(self.dx_max)
850        self.state.dx_min = copy.deepcopy(self.dx_min)
851        self.state.dxl = copy.deepcopy(self.dxl)
852        self.state.dxw = copy.deepcopy(self.dxw)
853        self.state.slit_smearer = copy.deepcopy(self.slit_smearer.GetValue())
854
855        if len(self._disp_obj_dict) > 0:
856            for k, v in self._disp_obj_dict.iteritems():
857                self.state._disp_obj_dict[k] = v.type
858
859            self.state.values = copy.deepcopy(self.values)
860            self.state.weights = copy.deepcopy(self.weights)
861        # save plotting range
862        self._save_plotting_range()
863
864        self.state.orientation_params = []
865        self.state.orientation_params_disp = []
866        self.state.parameters = []
867        self.state.fittable_param = []
868        self.state.fixed_param = []
869        self.state.str_parameters = []
870
871        # save checkbutton state and txtcrtl values
872        self._copy_parameters_state(self.str_parameters,
873                                    self.state.str_parameters)
874        self._copy_parameters_state(self.orientation_params,
875                                     self.state.orientation_params)
876        self._copy_parameters_state(self.orientation_params_disp,
877                                    self.state.orientation_params_disp)
878
879        self._copy_parameters_state(self.parameters, self.state.parameters)
880        self._copy_parameters_state(self.fittable_param,
881                                    self.state.fittable_param)
882        self._copy_parameters_state(self.fixed_param, self.state.fixed_param)
883        # save chisqr
884        self.state.tcChi = self.tcChi.GetValue()
885
886    def save_current_state_fit(self):
887        """
888        Store current state for fit_page
889        """
890        # save model option
891        if self.model is not None:
892            self.disp_list = self.model.getDispParamList()
893            self.state.disp_list = copy.deepcopy(self.disp_list)
894            self.state.model = self.model.clone()
895
896        self.state.enable2D = copy.deepcopy(self.enable2D)
897        self.state.values = copy.deepcopy(self.values)
898        self.state.weights = copy.deepcopy(self.weights)
899        # save data
900        self.state.data = copy.deepcopy(self.data)
901
902        if hasattr(self, "enable_disp"):
903            self.state.enable_disp = self.enable_disp.GetValue()
904            self.state.disable_disp = self.disable_disp.GetValue()
905
906        self.state.smearer = copy.deepcopy(self.current_smearer)
907        if hasattr(self, "enable_smearer"):
908            self.state.enable_smearer = \
909                                copy.deepcopy(self.enable_smearer.GetValue())
910            self.state.disable_smearer = \
911                                copy.deepcopy(self.disable_smearer.GetValue())
912
913        self.state.pinhole_smearer = \
914                                copy.deepcopy(self.pinhole_smearer.GetValue())
915        self.state.slit_smearer = copy.deepcopy(self.slit_smearer.GetValue())
916        self.state.dI_noweight = copy.deepcopy(self.dI_noweight.GetValue())
917        self.state.dI_didata = copy.deepcopy(self.dI_didata.GetValue())
918        self.state.dI_sqrdata = copy.deepcopy(self.dI_sqrdata.GetValue())
919        self.state.dI_idata = copy.deepcopy(self.dI_idata.GetValue())
920        if hasattr(self, "disp_box") and self.disp_box is not None:
921            self.state.disp_box = self.disp_box.GetCurrentSelection()
922
923            if len(self.disp_cb_dict) > 0:
924                for k, v in self.disp_cb_dict.iteritems():
925                    if v is None:
926                        self.state.disp_cb_dict[k] = v
927                    else:
928                        try:
929                            self.state.disp_cb_dict[k] = v.GetValue()
930                        except:
931                            self.state.disp_cb_dict[k] = None
932            if len(self._disp_obj_dict) > 0:
933                for k, v in self._disp_obj_dict.iteritems():
934                    self.state._disp_obj_dict[k] = v.type
935
936            self.state.values = copy.deepcopy(self.values)
937            self.state.weights = copy.deepcopy(self.weights)
938
939        # save plotting range
940        self._save_plotting_range()
941
942        # save checkbutton state and txtcrtl values
943        self._copy_parameters_state(self.orientation_params,
944                                    self.state.orientation_params)
945        self._copy_parameters_state(self.orientation_params_disp,
946                                    self.state.orientation_params_disp)
947        self._copy_parameters_state(self.parameters, self.state.parameters)
948        self._copy_parameters_state(self.fittable_param,
949                                    self.state.fittable_param)
950        self._copy_parameters_state(self.fixed_param, self.state.fixed_param)
951
952    def check_invalid_panel(self):
953        """
954        check if the user can already perform some action with this panel
955        """
956        if self.data is None:
957            self.disable_smearer.SetValue(True)
958            self.disable_disp.SetValue(True)
959            msg = "Please load Data and select Model to start..."
960            wx.MessageBox(msg, 'Info')
961            return True
962
963    def set_model_state(self, state):
964        """
965        reset page given a model state
966        """
967        self.disp_cb_dict = state.disp_cb_dict
968        self.disp_list = state.disp_list
969
970        # fill model combobox
971        self._show_combox_helper()
972        # select the current model
973        try:
974            # to support older version
975            category_pos = int(state.categorycombobox)
976        except:
977            category_pos = 0
978            for ind_cat in range(self.categorybox.GetCount()):
979                if self.categorycombobox.GetString(ind_cat) == \
980                                        state.categorycombobox:
981                    category_pos = int(ind_cat)
982                    break
983
984        self.categorybox.Select(category_pos)
985        try:
986            # to support older version
987            formfactor_pos = int(state.formfactorcombobox)
988        except:
989            formfactor_pos = 0
990            for ind_form in range(self.formfactorbox.GetCount()):
991                if self.formfactorbox.GetString(ind_form) == \
992                                        state.formfactorcombobox:
993                    formfactor_pos = int(ind_form)
994                    break
995
996        self.formfactorbox.Select(formfactor_pos)
997
998        try:
999            # to support older version
1000            structfactor_pos = int(state.structurecombobox)
1001        except:
1002            structfactor_pos = 0
1003            for ind_struct in range(self.structurebox.GetCount()):
1004                if self.structurebox.GetString(ind_struct) == \
1005                                        state.structurecombobox:
1006                    structfactor_pos = int(ind_struct)
1007                    break
1008
1009        self.structurebox.SetSelection(structfactor_pos)
1010
1011        if state.multi_factor is not None:
1012            self.multifactorbox.SetSelection(state.multi_factor)
1013
1014        # reset state of checkbox,textcrtl  and  regular parameters value
1015        self._reset_parameters_state(self.orientation_params_disp,
1016                                     state.orientation_params_disp)
1017        self._reset_parameters_state(self.orientation_params,
1018                                     state.orientation_params)
1019        self._reset_parameters_state(self.str_parameters,
1020                                     state.str_parameters)
1021        self._reset_parameters_state(self.parameters, state.parameters)
1022        # display dispersion info layer
1023        self.enable_disp.SetValue(state.enable_disp)
1024        self.disable_disp.SetValue(state.disable_disp)
1025
1026        if hasattr(self, "disp_box") and self.disp_box is not None:
1027            self.disp_box.SetSelection(state.disp_box)
1028            n = self.disp_box.GetCurrentSelection()
1029            dispersity = self.disp_box.GetClientData(n)
1030            name = dispersity.__name__
1031            self._set_dipers_Param(event=None)
1032
1033            if name == "ArrayDispersion":
1034
1035                for item in self.disp_cb_dict.keys():
1036
1037                    if hasattr(self.disp_cb_dict[item], "SetValue"):
1038                        self.disp_cb_dict[item].SetValue(
1039                                                    state.disp_cb_dict[item])
1040                        # Create the dispersion objects
1041                        disp_model = POLYDISPERSITY_MODELS['array']()
1042                        if hasattr(state, "values") and \
1043                                 self.disp_cb_dict[item].GetValue() is True:
1044                            if len(state.values) > 0:
1045                                self.values = state.values
1046                                self.weights = state.weights
1047                                disp_model.set_weights(self.values,
1048                                                       state.weights)
1049                            else:
1050                                self._reset_dispersity()
1051
1052                        self._disp_obj_dict[item] = disp_model
1053                        # Set the new model as the dispersion object
1054                        # for the selected parameter
1055                        self.model.set_dispersion(item, disp_model)
1056
1057                        self.model._persistency_dict[item] = \
1058                                                [state.values, state.weights]
1059
1060            else:
1061                keys = self.model.getParamList()
1062                for item in keys:
1063                    if item in self.disp_list and \
1064                            item not in self.model.details:
1065                        self.model.details[item] = ["", None, None]
1066                self.disp_cb_dict = copy.deepcopy(state.disp_cb_dict)
1067                self.state.disp_cb_dict = copy.deepcopy(state.disp_cb_dict)
1068        # smearing info  restore
1069        if hasattr(self, "enable_smearer"):
1070            # set smearing value whether or not the data
1071            # contain the smearing info
1072            self.enable_smearer.SetValue(state.enable_smearer)
1073            self.disable_smearer.SetValue(state.disable_smearer)
1074            self.onSmear(event=None)
1075        self.pinhole_smearer.SetValue(state.pinhole_smearer)
1076        self.slit_smearer.SetValue(state.slit_smearer)
1077
1078        self.dI_noweight.SetValue(state.dI_noweight)
1079        self.dI_didata.SetValue(state.dI_didata)
1080        self.dI_sqrdata.SetValue(state.dI_sqrdata)
1081        self.dI_idata.SetValue(state.dI_idata)
1082
1083        # we have two more options for smearing
1084        if self.pinhole_smearer.GetValue():
1085            self.onPinholeSmear(event=None)
1086        elif self.slit_smearer.GetValue():
1087            self.onSlitSmear(event=None)
1088
1089        # reset state of checkbox,textcrtl  and dispersity parameters value
1090        self._reset_parameters_state(self.fittable_param, state.fittable_param)
1091        self._reset_parameters_state(self.fixed_param, state.fixed_param)
1092
1093        # draw the model with previous parameters value
1094        self._onparamEnter_helper()
1095        self.select_param(event=None)
1096        # Save state_fit
1097        self.save_current_state_fit()
1098        self._lay_out()
1099        self.Refresh()
1100
1101    def get_cat_combo_box_pos(self, state):
1102        """
1103        Iterate through the categories to find the structurefactor
1104        :return: combo_box_position
1105        """
1106        for key, value in self.master_category_dict.iteritems():
1107            for list_item in value:
1108                if state.formfactorcombobox in list_item:
1109                    return self.categorybox.Items.index(key)
1110        return 0
1111
1112    def reset_page_helper(self, state):
1113        """
1114        Use page_state and change the state of existing page
1115
1116        :precondition: the page is already drawn or created
1117
1118        :postcondition: the state of the underlying data change as well as the
1119            state of the graphic interface
1120        """
1121        if state is None:
1122            return
1123        # set data, etc. from the state
1124        # reset page between theory and fitting from bookmarking
1125        data = state.data
1126
1127        if data is None:
1128            data_min = state.qmin
1129            data_max = state.qmax
1130            self.qmin_x = data_min
1131            self.qmax_x = data_max
1132            self.qmin.SetValue(str(data_min))
1133            self.qmax.SetValue(str(data_max))
1134
1135            self.state.data = data
1136            self.state.qmin = self.qmin_x
1137            self.state.qmax = self.qmax_x
1138        else:
1139            self.set_data(data)
1140
1141        self.enable2D = state.enable2D
1142        try:
1143            self.magnetic_on = state.magnetic_on
1144        except:
1145            # Backward compatibility (for older state files)
1146            self.magnetic_on = False
1147
1148        self.disp_cb_dict = state.disp_cb_dict
1149        self.disp_list = state.disp_list
1150
1151        # fill model combobox
1152        self._show_combox_helper()
1153        # select the current model
1154        try:
1155            # to support older version
1156            category_pos = int(state.categorycombobox)
1157        except:
1158            state.formfactorcombobox = state.formfactorcombobox.lower()
1159            state.formfactorcombobox = \
1160                state.formfactorcombobox.replace('model', '')
1161            state.formfactorcombobox = unicode(state.formfactorcombobox)
1162            state.categorycombobox = unicode(state.categorycombobox)
1163            if state.categorycombobox in self.categorybox.Items:
1164                category_pos = self.categorybox.Items.index(
1165                    state.categorycombobox)
1166            else:
1167                # Look in master list for model name (model.lower)
1168                category_pos = self.get_cat_combo_box_pos(state)
1169
1170        self.categorybox.Select(category_pos)
1171        self._show_combox(None)
1172        try:
1173            # to support older version
1174            formfactor_pos = int(state.formfactorcombobox)
1175        except:
1176            formfactor_pos = 0
1177            for ind_form in range(self.formfactorbox.GetCount()):
1178                if self.formfactorbox.GetString(ind_form) == \
1179                                                    (state.formfactorcombobox):
1180                    formfactor_pos = int(ind_form)
1181                    break
1182
1183        self.formfactorbox.Select(formfactor_pos)
1184
1185        structfactor_pos = 0
1186        try:
1187            # to support older version
1188            structfactor_pos = int(state.structurecombobox)
1189        except:
1190            if state.structurecombobox is not None:
1191                state.structurecombobox = unicode(state.structurecombobox)
1192                for ind_struct in range(self.structurebox.GetCount()):
1193                    if self.structurebox.GetString(ind_struct) == \
1194                                                    (state.structurecombobox):
1195                        structfactor_pos = int(ind_struct)
1196                        break
1197
1198        self.structurebox.SetSelection(structfactor_pos)
1199
1200        if state.multi_factor is not None:
1201            self.multifactorbox.SetSelection(state.multi_factor)
1202
1203        # draw the panel according to the new model parameter
1204        self._on_select_model(event=None)
1205
1206        # take care of 2D button
1207        if data is None and self.model_view.IsEnabled():
1208            if self.enable2D:
1209                self.model_view.SetLabel("2D Mode")
1210            else:
1211                self.model_view.SetLabel("1D Mode")
1212
1213        # reset state of checkbox,textcrtl  and  regular parameters value
1214        self._reset_parameters_state(self.orientation_params_disp,
1215                                     state.orientation_params_disp)
1216        self._reset_parameters_state(self.orientation_params,
1217                                     state.orientation_params)
1218        self._reset_parameters_state(self.str_parameters,
1219                                     state.str_parameters)
1220        self._reset_parameters_state(self.parameters, state.parameters)
1221        # display dispersion info layer
1222        self.enable_disp.SetValue(state.enable_disp)
1223        self.disable_disp.SetValue(state.disable_disp)
1224        # If the polydispersion is ON
1225        if state.enable_disp:
1226            # reset dispersion according the state
1227            self._set_dipers_Param(event=None)
1228            self._reset_page_disp_helper(state)
1229        # plotting range restore
1230        self._reset_plotting_range(state)
1231        # smearing info  restore
1232        if hasattr(self, "enable_smearer"):
1233            # set smearing value whether or not the data
1234            # contain the smearing info
1235            self.enable_smearer.SetValue(state.enable_smearer)
1236            self.disable_smearer.SetValue(state.disable_smearer)
1237            self.onSmear(event=None)
1238        self.pinhole_smearer.SetValue(state.pinhole_smearer)
1239        self.slit_smearer.SetValue(state.slit_smearer)
1240        try:
1241            self.dI_noweight.SetValue(state.dI_noweight)
1242            self.dI_didata.SetValue(state.dI_didata)
1243            self.dI_sqrdata.SetValue(state.dI_sqrdata)
1244            self.dI_idata.SetValue(state.dI_idata)
1245        except:
1246            # to support older state file formats
1247            self.dI_noweight.SetValue(False)
1248            self.dI_didata.SetValue(True)
1249            self.dI_sqrdata.SetValue(False)
1250            self.dI_idata.SetValue(False)
1251
1252        # we have two more options for smearing
1253        if self.pinhole_smearer.GetValue():
1254            self.dx_min = state.dx_min
1255            self.dx_max = state.dx_max
1256            if self.dx_min is not None:
1257                self.smear_pinhole_min.SetValue(str(self.dx_min))
1258            if self.dx_max is not None:
1259                self.smear_pinhole_max.SetValue(str(self.dx_max))
1260            self.onPinholeSmear(event=None)
1261        elif self.slit_smearer.GetValue():
1262            self.dxl = state.dxl
1263            self.dxw = state.dxw
1264            if self.dxl is not None:
1265                self.smear_slit_height.SetValue(str(self.dxl))
1266            if self.dxw is not None:
1267                self.smear_slit_width.SetValue(str(self.dxw))
1268            else:
1269                self.smear_slit_width.SetValue('')
1270            self.onSlitSmear(event=None)
1271
1272        # reset state of checkbox,textcrtl  and dispersity parameters value
1273        self._reset_parameters_state(self.fittable_param, state.fittable_param)
1274        self._reset_parameters_state(self.fixed_param, state.fixed_param)
1275
1276        # draw the model with previous parameters value
1277        self._onparamEnter_helper()
1278        # reset the value of chisqr when not consistent with the value computed
1279        self.tcChi.SetValue(str(self.state.tcChi))
1280        # reset context menu items
1281        self._reset_context_menu()
1282
1283        # set the value of the current state to the state given as parameter
1284        self.state = state.clone()
1285        self.state.m_name = self.m_name
1286
1287    def _reset_page_disp_helper(self, state):
1288        """
1289        Help to rest page for dispersions
1290        """
1291        keys = self.model.getParamList()
1292        for item in keys:
1293            if item in self.disp_list and \
1294                            item not in self.model.details:
1295                self.model.details[item] = ["", None, None]
1296        # for k,v in self.state.disp_cb_dict.iteritems():
1297        self.disp_cb_dict = copy.deepcopy(state.disp_cb_dict)
1298        self.state.disp_cb_dict = copy.deepcopy(state.disp_cb_dict)
1299        self.values = copy.deepcopy(state.values)
1300        self.weights = copy.deepcopy(state.weights)
1301
1302        for key, disp_type in state._disp_obj_dict.iteritems():
1303            # disp_model = disp
1304            disp_model = POLYDISPERSITY_MODELS[disp_type]()
1305            self._disp_obj_dict[key] = disp_model
1306            param_name = key.split('.')[0]
1307            # Try to set dispersion only when available
1308            # for eg., pass the orient. angles for 1D Cal
1309            try:
1310                self.model.set_dispersion(param_name, disp_model)
1311                self.model._persistency_dict[key] = \
1312                    [state.values, state.weights]
1313            except Exception:
1314                logging.error(traceback.format_exc())
1315            selection = self._find_polyfunc_selection(disp_model)
1316            for list in self.fittable_param:
1317                if list[1] == key and list[7] is not None:
1318                    list[7].SetSelection(selection)
1319                    # For the array disp_model, set the values and weights
1320                    if selection == 1:
1321                        disp_model.set_weights(self.values[key],
1322                                               self.weights[key])
1323                        try:
1324                            # Diables all fittable params for array
1325                            list[0].SetValue(False)
1326                            list[0].Disable()
1327                            list[2].Disable()
1328                            list[5].Disable()
1329                            list[6].Disable()
1330                        except Exception:
1331                            logging.error(traceback.format_exc())
1332            # For array, disable all fixed params
1333            if selection == 1:
1334                for item in self.fixed_param:
1335                    if item[1].split(".")[0] == key.split(".")[0]:
1336                        # try it and pass it for the orientation for 1D
1337                        try:
1338                            item[2].Disable()
1339                        except Exception:
1340                            logging.error(traceback.format_exc())
1341
1342    def _selectDlg(self):
1343        """
1344        open a dialog file to selected the customized dispersity
1345        """
1346        if self.parent is not None:
1347            self._default_save_location = \
1348                        self._manager.parent.get_save_location()
1349        dlg = wx.FileDialog(self, "Choose a weight file",
1350                            self._default_save_location, "",
1351                            "*.*", wx.OPEN)
1352        path = None
1353        if dlg.ShowModal() == wx.ID_OK:
1354            path = dlg.GetPath()
1355        dlg.Destroy()
1356        return path
1357
1358    def _reset_context_menu(self):
1359        """
1360        reset the context menu
1361        """
1362        ids = iter(self._id_pool)  # Reusing ids for context menu
1363        for name, _ in self.state.saved_states.iteritems():
1364            self.number_saved_state += 1
1365            # Add item in the context menu
1366            wx_id = ids.next()
1367            msg = 'Save model and state %g' % self.number_saved_state
1368            self.popUpMenu.Append(wx_id, name, msg)
1369            wx.EVT_MENU(self, wx_id, self.onResetModel)
1370
1371    def _reset_plotting_range(self, state):
1372        """
1373        Reset the plotting range to a given state
1374        """
1375        self.qmin.SetValue(str(state.qmin))
1376        self.qmax.SetValue(str(state.qmax))
1377
1378    def _save_typeOfmodel(self):
1379        """
1380        save radiobutton containing the type model that can be selected
1381        """
1382        # self.state.shape_rbutton = self.shape_rbutton.GetValue()
1383        # self.state.shape_indep_rbutton = self.shape_indep_rbutton.GetValue()
1384        # self.state.struct_rbutton = self.struct_rbutton.GetValue()
1385        # self.state.plugin_rbutton = self.plugin_rbutton.GetValue()
1386        self.state.structurecombobox = self.structurebox.GetLabel()
1387        self.state.formfactorcombobox = self.formfactorbox.GetLabel()
1388        self.state.categorycombobox = self.categorybox.GetLabel()
1389
1390        # post state to fit panel
1391        event = PageInfoEvent(page=self)
1392        wx.PostEvent(self.parent, event)
1393
1394    def _save_plotting_range(self):
1395        """
1396        save the state of plotting range
1397        """
1398        self.state.qmin = self.qmin_x
1399        self.state.qmax = self.qmax_x
1400        self.state.npts = self.npts_x
1401
1402    def _onparamEnter_helper(self, is_modified=False):
1403        """
1404        check if values entered by the user are changed and valid to replot
1405        model
1406        """
1407        # Flag to register when a parameter has changed.
1408        # is_modified = False
1409        self.fitrange = True
1410        is_2Ddata = False
1411        # self._undo.Enable(True)
1412        # check if 2d data
1413        if self.data.__class__.__name__ == "Data2D":
1414            is_2Ddata = True
1415        if self.model is not None:
1416            # Either we get a is_modified = True passed in because
1417            # _update_paramv_on_fit() has been called already or
1418            # we need to check here ourselves.
1419            if not is_modified:
1420                is_modified = (self._check_value_enter(self.fittable_param)
1421                               or self._check_value_enter(self.fixed_param)
1422                               or self._check_value_enter(self.parameters))
1423
1424            # Here we should check whether the boundaries have been modified.
1425            # If qmin and qmax have been modified, update qmin and qmax and
1426            # set the is_modified flag to True
1427            if self._validate_qrange(self.qmin, self.qmax):
1428                tempmin = float(self.qmin.GetValue())
1429                if tempmin != self.qmin_x:
1430                    self.qmin_x = tempmin
1431                    is_modified = True
1432                tempmax = float(self.qmax.GetValue())
1433                if tempmax != self.qmax_x:
1434                    self.qmax_x = tempmax
1435                    is_modified = True
1436
1437                if is_2Ddata:
1438                    # set mask
1439                    is_modified = self._validate_Npts()
1440
1441            else:
1442                self.fitrange = False
1443
1444            # if any value is modify draw model with new value
1445            if not self.fitrange:
1446                # self.btFit.Disable()
1447                if is_2Ddata:
1448                    self.btEditMask.Disable()
1449            else:
1450                if is_2Ddata and self.data.is_data and not self.batch_on:
1451                    self.btEditMask.Enable(True)
1452            if is_modified and self.fitrange:
1453                # Theory case: need to get npts value to draw
1454                self.npts_x = float(self.Npts_total.GetValue())
1455                self.create_default_data()
1456                self.state_change = True
1457                self._draw_model()
1458                # Time delay has been introduced to prevent _handle error
1459                # on Windows
1460                # This part of code is executed when model is selected and
1461                # it's parameters are changed (with respect to previously
1462                # selected model). There are two Iq evaluations occuring one
1463                # after another and therefore there may be compilation error
1464                # if model is calculated for the first time.
1465                # This seems to be Windows only issue - haven't tested on Linux
1466                # though.The proper solution (other than time delay) requires
1467                # more fundemental code refatoring
1468                # Wojtek P. Nov 7, 2016
1469                if not ON_MAC:
1470                    time.sleep(0.1)
1471                self.Refresh()
1472
1473        # logging.info("is_modified flag set to %g",is_modified)
1474        return is_modified
1475
1476    def _update_paramv_on_fit(self):
1477        """
1478        make sure that update param values just before the fitting
1479        """
1480        # flag for qmin qmax check values
1481        flag = True
1482        self.fitrange = True
1483        is_modified = False
1484
1485        # wx.PostEvent(self._manager.parent, StatusEvent(status=" \
1486        # updating ... ",type="update"))
1487
1488        # So make sure that update param values on_Fit.
1489        # self._undo.Enable(True)
1490        if self.model is not None:
1491            if self.Npts_total.GetValue() != self.Npts_fit.GetValue():
1492                if not self.data.is_data:
1493                    self._manager.page_finder[self.uid].set_fit_data(
1494                        data=[self.data])
1495            # Check the values
1496            is_modified = (self._check_value_enter(self.fittable_param)
1497                           or self._check_value_enter(self.fixed_param)
1498                           or self._check_value_enter(self.parameters))
1499
1500            # If qmin and qmax have been modified, update qmin and qmax and
1501            # Here we should check whether the boundaries have been modified.
1502            # If qmin and qmax have been modified, update qmin and qmax and
1503            # set the is_modified flag to True
1504            self.fitrange = self._validate_qrange(self.qmin, self.qmax)
1505            if self.fitrange:
1506                tempmin = float(self.qmin.GetValue())
1507                if tempmin != self.qmin_x:
1508                    self.qmin_x = tempmin
1509                tempmax = float(self.qmax.GetValue())
1510                if tempmax != self.qmax_x:
1511                    self.qmax_x = tempmax
1512                if tempmax == tempmin:
1513                    flag = False
1514                temp_smearer = None
1515                if not self.disable_smearer.GetValue():
1516                    temp_smearer = self.current_smearer
1517                    if self.slit_smearer.GetValue():
1518                        flag = self.update_slit_smear()
1519                    elif self.pinhole_smearer.GetValue():
1520                        flag = self.update_pinhole_smear()
1521                    else:
1522                        enable_smearer = not self.disable_smearer.GetValue()
1523                        self._manager.set_smearer(smearer=temp_smearer,
1524                                                  uid=self.uid,
1525                                                  fid=self.data.id,
1526                                                  qmin=float(self.qmin_x),
1527                                                  qmax=float(self.qmax_x),
1528                                                  enable_smearer=enable_smearer,
1529                                                  draw=False)
1530                elif not self._is_2D():
1531                    enable_smearer = not self.disable_smearer.GetValue()
1532                    self._manager.set_smearer(smearer=temp_smearer,
1533                                              qmin=float(self.qmin_x),
1534                                              uid=self.uid,
1535                                              fid=self.data.id,
1536                                              qmax=float(self.qmax_x),
1537                                              enable_smearer=enable_smearer,
1538                                              draw=False)
1539                    if self.data is not None:
1540                        index_data = ((self.qmin_x <= self.data.x) &
1541                                      (self.data.x <= self.qmax_x))
1542                        val = str(len(self.data.x[index_data is True]))
1543                        self.Npts_fit.SetValue(val)
1544                    else:
1545                        # No data in the panel
1546                        try:
1547                            self.npts_x = float(self.Npts_total.GetValue())
1548                        except:
1549                            flag = False
1550                            return flag
1551                    flag = True
1552                if self._is_2D():
1553                    # only 2D case set mask
1554                    flag = self._validate_Npts()
1555                    if not flag:
1556                        return flag
1557            else:
1558                flag = False
1559        else:
1560            flag = False
1561
1562        # For invalid q range, disable the mask editor and fit button, vs.
1563        if not self.fitrange:
1564            if self._is_2D():
1565                self.btEditMask.Disable()
1566        else:
1567            if self._is_2D() and self.data.is_data and not self.batch_on:
1568                self.btEditMask.Enable(True)
1569
1570        if not flag:
1571            msg = "Cannot Plot or Fit :Must select a "
1572            msg += " model or Fitting range is not valid!!!  "
1573            wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1574
1575        try:
1576            self.save_current_state()
1577        except Exception:
1578            logging.error(traceback.format_exc())
1579
1580        return flag, is_modified
1581
1582    def _reset_parameters_state(self, listtorestore, statelist):
1583        """
1584        Reset the parameters at the given state
1585        """
1586        if len(statelist) == 0 or len(listtorestore) == 0:
1587            return
1588        if len(statelist) != len(listtorestore):
1589            return
1590
1591        for j in range(len(listtorestore)):
1592            item_page = listtorestore[j]
1593            item_page_info = statelist[j]
1594            # change the state of the check box for simple parameters
1595            if item_page[0] is not None:
1596                item_page[0].SetValue(item_page_info[0])
1597            if item_page[2] is not None:
1598                item_page[2].SetValue(item_page_info[2])
1599                if item_page[2].__class__.__name__ == "ComboBox":
1600                    if item_page_info[2] in self.model.fun_list:
1601                        fun_val = self.model.fun_list[item_page_info[2]]
1602                        self.model.setParam(item_page_info[1], fun_val)
1603            if item_page[3] is not None:
1604                # show or hide text +/-
1605                if item_page_info[2]:
1606                    item_page[3].Show(True)
1607                else:
1608                    item_page[3].Hide()
1609            if item_page[4] is not None:
1610                # show of hide the text crtl for fitting error
1611                if item_page_info[4][0]:
1612                    item_page[4].Show(True)
1613                    item_page[4].SetValue(item_page_info[4][1])
1614                else:
1615                    item_page[3].Hide()
1616            if item_page[5] is not None:
1617                # show of hide the text crtl for fitting error
1618                item_page[5].Show(item_page_info[5][0])
1619                item_page[5].SetValue(item_page_info[5][1])
1620
1621            if item_page[6] is not None:
1622                # show of hide the text crtl for fitting error
1623                item_page[6].Show(item_page_info[6][0])
1624                item_page[6].SetValue(item_page_info[6][1])
1625
1626    def _reset_strparam_state(self, listtorestore, statelist):
1627        """
1628        Reset the string parameters at the given state
1629        """
1630        if len(statelist) == 0:
1631            return
1632
1633        listtorestore = copy.deepcopy(statelist)
1634
1635        for j in range(len(listtorestore)):
1636            item_page = listtorestore[j]
1637            item_page_info = statelist[j]
1638            # change the state of the check box for simple parameters
1639
1640            if item_page[0] is not None:
1641                item_page[0].SetValue(format_number(item_page_info[0], True))
1642
1643            if item_page[2] is not None:
1644                param_name = item_page_info[1]
1645                value = item_page_info[2]
1646                selection = value
1647                if value in self.model.fun_list:
1648                    selection = self.model.fun_list[value]
1649                item_page[2].SetValue(selection)
1650                self.model.setParam(param_name, selection)
1651
1652    def _copy_parameters_state(self, listtocopy, statelist):
1653        """
1654        copy the state of button
1655
1656        :param listtocopy: the list of check button to copy
1657        :param statelist: list of state object to store the current state
1658
1659        """
1660        if len(listtocopy) == 0:
1661            return
1662
1663        for item in listtocopy:
1664
1665            checkbox_state = None
1666            if item[0] is not None:
1667                checkbox_state = item[0].GetValue()
1668            parameter_name = item[1]
1669            parameter_value = None
1670            if item[2] is not None:
1671                parameter_value = item[2].GetValue()
1672            static_text = None
1673            if item[3] is not None:
1674                static_text = item[3].IsShown()
1675            error_value = None
1676            error_state = None
1677            if item[4] is not None:
1678                error_value = item[4].GetValue()
1679                error_state = item[4].IsShown()
1680
1681            min_value = None
1682            min_state = None
1683            if item[5] is not None:
1684                min_value = item[5].GetValue()
1685                min_state = item[5].IsShown()
1686
1687            max_value = None
1688            max_state = None
1689            if item[6] is not None:
1690                max_value = item[6].GetValue()
1691                max_state = item[6].IsShown()
1692            unit = None
1693            if item[7] is not None:
1694                unit = item[7].GetLabel()
1695
1696            statelist.append([checkbox_state, parameter_name, parameter_value,
1697                              static_text, [error_state, error_value],
1698                              [min_state, min_value],
1699                              [max_state, max_value], unit])
1700
1701    def _draw_model(self, update_chisqr=True, source='model'):
1702        """
1703        Method to draw or refresh a plotted model.
1704        The method will use the data member from the model page
1705        to build a call to the fitting perspective manager.
1706
1707        :param chisqr: update chisqr value [bool]
1708        """
1709        wx.CallAfter(self._draw_model_after, update_chisqr, source)
1710
1711    def _draw_model_after(self, update_chisqr=True, source='model'):
1712        """
1713        Method to draw or refresh a plotted model.
1714        The method will use the data member from the model page
1715        to build a call to the fitting perspective manager.
1716
1717        :param chisqr: update chisqr value [bool]
1718        """
1719        # if self.check_invalid_panel():
1720        #    return
1721        if self.model is not None:
1722            temp_smear = None
1723            if hasattr(self, "enable_smearer"):
1724                if not self.disable_smearer.GetValue():
1725                    temp_smear = self.current_smearer
1726            # compute weight for the current data
1727            from sas.sasgui.perspectives.fitting.utils import get_weight
1728            flag = self.get_weight_flag()
1729            weight = get_weight(data=self.data, is2d=self._is_2D(), flag=flag)
1730            toggle_mode_on = self.model_view.IsEnabled()
1731            is_2d = self._is_2D()
1732            self._manager.draw_model(self.model,
1733                                     data=self.data,
1734                                     smearer=temp_smear,
1735                                     qmin=float(self.qmin_x),
1736                                     qmax=float(self.qmax_x),
1737                                     page_id=self.uid,
1738                                     toggle_mode_on=toggle_mode_on,
1739                                     state=self.state,
1740                                     enable2D=is_2d,
1741                                     update_chisqr=update_chisqr,
1742                                     source='model',
1743                                     weight=weight)
1744
1745    def _on_show_sld(self, event=None):
1746        """
1747        Plot SLD profile
1748        """
1749        # get profile data
1750        x, y = self.model.getProfile()
1751
1752        from sas.sasgui.plottools import Data1D as pf_data1d
1753        # from sas.sasgui.perspectives.theory.profile_dialog import SLDPanel
1754        from sas.sasgui.guiframe.local_perspectives.plotting.profile_dialog \
1755            import SLDPanel
1756        sld_data = pf_data1d(x, y)
1757        sld_data.name = 'SLD'
1758        sld_data.axes = self.sld_axes
1759        self.panel = SLDPanel(self, data=sld_data, axes=self.sld_axes,
1760                              id=wx.ID_ANY)
1761        self.panel.ShowModal()
1762
1763    def _set_multfactor_combobox(self, multiplicity=10):
1764        """
1765        Set comboBox for muitfactor of CoreMultiShellModel
1766        :param multiplicit: no. of multi-functionality
1767        """
1768        # build content of the combobox
1769        for idx in range(0, multiplicity):
1770            self.multifactorbox.Append(str(idx), int(idx))
1771        self._hide_multfactor_combobox()
1772
1773    def _show_multfactor_combobox(self):
1774        """
1775        Show the comboBox of muitfactor of CoreMultiShellModel
1776        """
1777        if not self.mutifactor_text.IsShown():
1778            self.mutifactor_text.Show(True)
1779            self.mutifactor_text1.Show(True)
1780        if not self.multifactorbox.IsShown():
1781            self.multifactorbox.Show(True)
1782
1783    def _hide_multfactor_combobox(self):
1784        """
1785        Hide the comboBox of muitfactor of CoreMultiShellModel
1786        """
1787        if self.mutifactor_text.IsShown():
1788            self.mutifactor_text.Hide()
1789            self.mutifactor_text1.Hide()
1790        if self.multifactorbox.IsShown():
1791            self.multifactorbox.Hide()
1792
1793    def formfactor_combo_init(self):
1794        """
1795        First time calls _show_combox_helper
1796        """
1797        self._show_combox(None)
1798
1799    def _show_combox_helper(self):
1800        """
1801        Fill panel's combo box according to the type of model selected
1802        """
1803        custom_model = 'Customized Models'
1804        mod_cat = self.categorybox.GetStringSelection()
1805        self.structurebox.SetSelection(0)
1806        self.structurebox.Disable()
1807        self.formfactorbox.Clear()
1808        if mod_cat is None:
1809            return
1810        m_list = []
1811        try:
1812            if mod_cat == custom_model:
1813                for model in self.model_list_box[mod_cat]:
1814                    m_list.append(self.model_dict[model.name])
1815            else:
1816                cat_dic = self.master_category_dict[mod_cat]
1817                for (model, enabled) in cat_dic:
1818                    if enabled:
1819                        m_list.append(self.model_dict[model])
1820        except Exception:
1821            msg = traceback.format_exc()
1822            wx.PostEvent(self._manager.parent,
1823                         StatusEvent(status=msg, info="error"))
1824        self._populate_box(self.formfactorbox, m_list)
1825
1826    def _on_modify_cat(self, event=None):
1827        """
1828        Called when category manager is opened
1829        """
1830        self._manager.parent.on_category_panel(event)
1831
1832    def _show_combox(self, event=None):
1833        """
1834        Show combox box associate with type of model selected
1835        """
1836        self.Show(False)
1837        self._show_combox_helper()
1838        self._on_select_model(event=None)
1839        self.Show(True)
1840        self._save_typeOfmodel()
1841        self.sizer4_4.Layout()
1842        self.sizer4.Layout()
1843        self.Layout()
1844        self.Refresh()
1845
1846    def _populate_box(self, combobox, list):
1847        """
1848        fill combox box with dict item
1849
1850        :param list: contains item to fill the combox
1851            item must model class
1852        """
1853        mlist = []
1854        for models in list:
1855            if models.name != "NoStructure":
1856                mlist.append((models.name, models))
1857
1858        # Sort the models
1859        mlist_sorted = sorted(mlist)
1860        for item in mlist_sorted:
1861            combobox.Append(item[0], item[1])
1862        return 0
1863
1864    def _onQrangeEnter(self, event):
1865        """
1866        Check validity of value enter in the Q range field
1867
1868        """
1869        tcrtl = event.GetEventObject()
1870        # Clear msg if previously shown.
1871        msg = ""
1872        wx.PostEvent(self.parent, StatusEvent(status=msg))
1873        # Flag to register when a parameter has changed.
1874        if tcrtl.GetValue().lstrip().rstrip() != "":
1875            try:
1876                float(tcrtl.GetValue())
1877                tcrtl.SetBackgroundColour(wx.WHITE)
1878                # If qmin and qmax have been modified, update qmin and qmax
1879                if self._validate_qrange(self.qmin, self.qmax):
1880                    tempmin = float(self.qmin.GetValue())
1881                    if tempmin != self.qmin_x:
1882                        self.qmin_x = tempmin
1883                    tempmax = float(self.qmax.GetValue())
1884                    if tempmax != self.qmax_x:
1885                        self.qmax_x = tempmax
1886                else:
1887                    tcrtl.SetBackgroundColour("pink")
1888                    msg = "Model Error: wrong value entered: %s" % \
1889                          sys.exc_info()[1]
1890                    wx.PostEvent(self.parent, StatusEvent(status=msg))
1891                    return
1892            except:
1893                tcrtl.SetBackgroundColour("pink")
1894                msg = "Model Error: wrong value entered: %s" % sys.exc_info()[1]
1895                wx.PostEvent(self.parent, StatusEvent(status=msg))
1896                return
1897            # Check if # of points for theory model are valid(>0).
1898            if self.npts is not None:
1899                if check_float(self.npts):
1900                    temp_npts = float(self.npts.GetValue())
1901                    if temp_npts != self.num_points:
1902                        self.num_points = temp_npts
1903                else:
1904                    msg = "Cannot plot: No points in Q range!!!  "
1905                    wx.PostEvent(self.parent, StatusEvent(status=msg))
1906        else:
1907            tcrtl.SetBackgroundColour("pink")
1908            msg = "Model Error: wrong value entered!!!"
1909            wx.PostEvent(self.parent, StatusEvent(status=msg))
1910        self.save_current_state()
1911        event = PageInfoEvent(page=self)
1912        wx.PostEvent(self.parent, event)
1913        self.state_change = False
1914        # Draw the model for a different range
1915        if not self.data.is_data:
1916            self.create_default_data()
1917        self._draw_model()
1918
1919    def _theory_qrange_enter(self, event):
1920        """
1921        Check validity of value enter in the Q range field
1922        """
1923
1924        tcrtl = event.GetEventObject()
1925        # Clear msg if previously shown.
1926        msg = ""
1927        wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1928        # Flag to register when a parameter has changed.
1929        is_modified = False
1930        if tcrtl.GetValue().lstrip().rstrip() != "":
1931            try:
1932                value = float(tcrtl.GetValue())
1933                tcrtl.SetBackgroundColour(wx.WHITE)
1934
1935                # If qmin and qmax have been modified, update qmin and qmax
1936                if self._validate_qrange(self.theory_qmin, self.theory_qmax):
1937                    tempmin = float(self.theory_qmin.GetValue())
1938                    if tempmin != self.theory_qmin_x:
1939                        self.theory_qmin_x = tempmin
1940                    tempmax = float(self.theory_qmax.GetValue())
1941                    if tempmax != self.qmax_x:
1942                        self.theory_qmax_x = tempmax
1943                else:
1944                    tcrtl.SetBackgroundColour("pink")
1945                    msg = "Model Error: wrong value entered: %s" % \
1946                          sys.exc_info()[1]
1947                    wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1948                    return
1949            except:
1950                tcrtl.SetBackgroundColour("pink")
1951                msg = "Model Error: wrong value entered: %s" % sys.exc_info()[1]
1952                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1953                return
1954            # Check if # of points for theory model are valid(>0).
1955            if self.Npts_total.IsEditable():
1956                if check_float(self.Npts_total):
1957                    temp_npts = float(self.Npts_total.GetValue())
1958                    if temp_npts != self.num_points:
1959                        self.num_points = temp_npts
1960                        is_modified = True
1961                else:
1962                    msg = "Cannot Plot: No points in Q range!!!  "
1963                    wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1964        else:
1965            tcrtl.SetBackgroundColour("pink")
1966            msg = "Model Error: wrong value entered!!!"
1967            wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1968        self.save_current_state()
1969        event = PageInfoEvent(page=self)
1970        wx.PostEvent(self.parent, event)
1971        self.state_change = False
1972        # Draw the model for a different range
1973        self.create_default_data()
1974        self._draw_model()
1975
1976    def _on_select_model_helper(self):
1977        """
1978        call back for model selection
1979        """
1980        # reset dictionary containing reference to dispersion
1981        self._disp_obj_dict = {}
1982        self.disp_cb_dict = {}
1983        self.temp_multi_functional = False
1984        f_id = self.formfactorbox.GetCurrentSelection()
1985        # For MAC
1986        form_factor = None
1987        if f_id >= 0:
1988            form_factor = self.formfactorbox.GetClientData(f_id)
1989
1990        if form_factor is None or \
1991            not hasattr(form_factor, 'is_form_factor') or \
1992                not form_factor.is_form_factor:
1993            self.structurebox.Hide()
1994            self.text2.Hide()
1995            self.structurebox.Disable()
1996            self.structurebox.SetSelection(0)
1997            self.text2.Disable()
1998        else:
1999            self.structurebox.Show()
2000            self.text2.Show()
2001            self.structurebox.Enable()
2002            self.text2.Enable()
2003
2004        if form_factor is not None:
2005            # set multifactor for Mutifunctional models
2006            if form_factor.is_multiplicity_model:
2007                m_id = self.multifactorbox.GetCurrentSelection()
2008                multiplicity = form_factor.multiplicity_info[0]
2009                self.multifactorbox.Clear()
2010                self._set_multfactor_combobox(multiplicity)
2011                self._show_multfactor_combobox()
2012                # ToDo: this info should be called directly from the model
2013                text = form_factor.multiplicity_info[1]  # 'No. of Shells: '
2014
2015                self.mutifactor_text.SetLabel(text)
2016                if m_id > multiplicity - 1:
2017                    # default value
2018                    m_id = 1
2019
2020                self.multi_factor = self.multifactorbox.GetClientData(m_id)
2021                if self.multi_factor is None:
2022                    self.multi_factor = 0
2023                self.multifactorbox.SetSelection(m_id)
2024                # Check len of the text1 and max_multiplicity
2025                text = ''
2026                if form_factor.multiplicity_info[0] == \
2027                        len(form_factor.multiplicity_info[2]):
2028                    text = form_factor.multiplicity_info[2][self.multi_factor]
2029                self.mutifactor_text1.SetLabel(text)
2030                # Check if model has  get sld profile.
2031                if len(form_factor.multiplicity_info[3]) > 0:
2032                    self.sld_axes = form_factor.multiplicity_info[3]
2033                    self.show_sld_button.Show(True)
2034                else:
2035                    self.sld_axes = ""
2036            else:
2037                self._hide_multfactor_combobox()
2038                self.show_sld_button.Hide()
2039                self.multi_factor = None
2040        else:
2041            self._hide_multfactor_combobox()
2042            self.show_sld_button.Hide()
2043            self.multi_factor = None
2044
2045        s_id = self.structurebox.GetCurrentSelection()
2046        struct_factor = self.structurebox.GetClientData(s_id)
2047
2048        if struct_factor is not None:
2049            from sasmodels.sasview_model import MultiplicationModel
2050            self.model = MultiplicationModel(form_factor(self.multi_factor),
2051                                             struct_factor())
2052            # multifunctional form factor
2053            if len(form_factor.non_fittable) > 0:
2054                self.temp_multi_functional = True
2055        elif form_factor is not None:
2056            if self.multi_factor is not None:
2057                self.model = form_factor(self.multi_factor)
2058            else:
2059                # old style plugin models do not accept a multiplicity argument
2060                self.model = form_factor()
2061        else:
2062            self.model = None
2063            return
2064
2065        # check if model has magnetic parameters
2066        if len(self.model.magnetic_params) > 0:
2067            self._has_magnetic = True
2068        else:
2069            self._has_magnetic = False
2070        # post state to fit panel
2071        self.state.parameters = []
2072        self.state.model = self.model
2073        self.state.qmin = self.qmin_x
2074        self.state.multi_factor = self.multi_factor
2075        self.disp_list = self.model.getDispParamList()
2076        self.state.disp_list = self.disp_list
2077        self.on_set_focus(None)
2078        self.Layout()
2079
2080    def _validate_qrange(self, qmin_ctrl, qmax_ctrl):
2081        """
2082        Verify that the Q range controls have valid values
2083        and that Qmin < Qmax.
2084
2085        :param qmin_ctrl: text control for Qmin
2086        :param qmax_ctrl: text control for Qmax
2087
2088        :return: True is the Q range is value, False otherwise
2089
2090        """
2091        qmin_validity = check_float(qmin_ctrl)
2092        qmax_validity = check_float(qmax_ctrl)
2093        if not (qmin_validity and qmax_validity):
2094            return False
2095        else:
2096            qmin = float(qmin_ctrl.GetValue())
2097            qmax = float(qmax_ctrl.GetValue())
2098            if qmin < qmax:
2099                # Make sure to set both colours white.
2100                qmin_ctrl.SetBackgroundColour(wx.WHITE)
2101                qmin_ctrl.Refresh()
2102                qmax_ctrl.SetBackgroundColour(wx.WHITE)
2103                qmax_ctrl.Refresh()
2104            else:
2105                qmin_ctrl.SetBackgroundColour("pink")
2106                qmin_ctrl.Refresh()
2107                qmax_ctrl.SetBackgroundColour("pink")
2108                qmax_ctrl.Refresh()
2109                msg = "Invalid Q range: Q min must be smaller than Q max"
2110                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
2111                return False
2112        return True
2113
2114    def _validate_Npts(self):
2115        """
2116        Validate the number of points for fitting is more than 10 points.
2117        If valid, setvalues Npts_fit otherwise post msg.
2118        """
2119        # default flag
2120        flag = True
2121        # Theory
2122        if self.data is None and self.enable2D:
2123            return flag
2124        for data in self.data_list:
2125            # q value from qx and qy
2126            radius = numpy.sqrt(data.qx_data * data.qx_data +
2127                                data.qy_data * data.qy_data)
2128            # get unmasked index
2129            index_data = (float(self.qmin.GetValue()) <= radius) & \
2130                         (radius <= float(self.qmax.GetValue()))
2131            index_data = (index_data) & (data.mask)
2132            index_data = (index_data) & (numpy.isfinite(data.data))
2133
2134            if len(index_data[index_data]) < 10:
2135                # change the color pink.
2136                self.qmin.SetBackgroundColour("pink")
2137                self.qmin.Refresh()
2138                self.qmax.SetBackgroundColour("pink")
2139                self.qmax.Refresh()
2140                msg = "Data Error: "
2141                msg += "Too few points in %s." % data.name
2142                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
2143                self.fitrange = False
2144                flag = False
2145            else:
2146                self.Npts_fit.SetValue(str(len(index_data[index_data is True])))
2147                self.fitrange = True
2148
2149        return flag
2150
2151    def _validate_Npts_1D(self):
2152        """
2153        Validate the number of points for fitting is more than 5 points.
2154        If valid, setvalues Npts_fit otherwise post msg.
2155        """
2156        # default flag
2157        flag = True
2158        # Theory
2159        if self.data is None:
2160            return flag
2161        for data in self.data_list:
2162            # q value from qx and qy
2163            radius = data.x
2164            # get unmasked index
2165            index_data = (float(self.qmin.GetValue()) <= radius) & \
2166                         (radius <= float(self.qmax.GetValue()))
2167            index_data = (index_data) & (numpy.isfinite(data.y))
2168
2169            if len(index_data[index_data]) < 5:
2170                # change the color pink.
2171                self.qmin.SetBackgroundColour("pink")
2172                self.qmin.Refresh()
2173                self.qmax.SetBackgroundColour("pink")
2174                self.qmax.Refresh()
2175                msg = "Data Error: "
2176                msg += "Too few points in %s." % data.name
2177                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
2178                self.fitrange = False
2179                flag = False
2180            else:
2181                self.Npts_fit.SetValue(str(len(index_data[index_data is True])))
2182                self.fitrange = True
2183
2184        return flag
2185
2186    def _check_value_enter(self, list):
2187        """
2188        :param list: model parameter and panel info
2189        :Note: each item of the list should be as follow:
2190            item=[check button state, parameter's name,
2191                paramater's value, string="+/-",
2192                parameter's error of fit,
2193                parameter's minimum value,
2194                parameter's maximum value ,
2195                parameter's units]
2196
2197        Returns True if the model parameters have changed.
2198        """
2199        is_modified = False
2200        for item in list:
2201            # skip angle parameters for 1D
2202            if not self.enable2D and item in self.orientation_params:
2203                continue
2204
2205            value_ctrl = item[2]
2206            if not value_ctrl.IsEnabled():
2207                # ArrayDispersion disables PD, Min, Max, Npts, Nsigs
2208                continue
2209
2210            name = item[1]
2211            value_str = value_ctrl.GetValue().strip()
2212            if name.endswith(".npts"):
2213                validity = check_int(value_ctrl)
2214                if not validity:
2215                    continue
2216                value = int(value_str)
2217
2218            elif name.endswith(".nsigmas"):
2219                validity = check_float(value_ctrl)
2220                if not validity:
2221                    continue
2222                value = float(value_str)
2223
2224            else:  # value or polydispersity
2225
2226                # Check that min, max and value are floats
2227                min_ctrl, max_ctrl = item[5], item[6]
2228                min_str = min_ctrl.GetValue().strip()
2229                max_str = max_ctrl.GetValue().strip()
2230                validity = check_float(value_ctrl)
2231                if min_str != "":
2232                    validity = validity and check_float(min_ctrl)
2233                if max_str != "":
2234                    validity = validity and check_float(max_ctrl)
2235                if not validity:
2236                    continue
2237
2238                # Check that min is less than max
2239                low = -numpy.inf if min_str == "" else float(min_str)
2240                high = numpy.inf if max_str == "" else float(max_str)
2241                if high < low:
2242                    min_ctrl.SetBackgroundColour("pink")
2243                    min_ctrl.Refresh()
2244                    max_ctrl.SetBackgroundColour("pink")
2245                    max_ctrl.Refresh()
2246                    # msg = "Invalid fit range for %s: min must be smaller
2247                    # than max"%name
2248                    # wx.PostEvent(self._manager.parent,
2249                    # StatusEvent(status=msg))
2250                    continue
2251
2252                # Force value between min and max
2253                value = float(value_str)
2254                if value < low:
2255                    value = low
2256                    value_ctrl.SetValue(format_number(value))
2257                elif value > high:
2258                    value = high
2259                    value_ctrl.SetValue(format_number(value))
2260
2261                if name not in self.model.details.keys():
2262                    self.model.details[name] = ["", None, None]
2263                old_low, old_high = self.model.details[name][1:3]
2264                if old_low != low or old_high != high:
2265                    # The configuration has changed but it won't change the
2266                    # computed curve so no need to set is_modified to True
2267                    # is_modified = True
2268                    self.model.details[name][1:3] = low, high
2269
2270            # Update value in model if it has changed
2271            if value != self.model.getParam(name):
2272                self.model.setParam(name, value)
2273                is_modified = True
2274
2275        return is_modified
2276
2277    def _set_dipers_Param(self, event):
2278        """
2279        respond to self.enable_disp and self.disable_disp radio box.
2280        The dispersity object is reset inside the model into Gaussian.
2281        When the user select yes , this method display a combo box for
2282        more selection when the user selects No,the combo box disappears.
2283        Redraw the model with the default dispersity (Gaussian)
2284        """
2285        # On selction if no model exists.
2286        if self.model is None:
2287            self.disable_disp.SetValue(True)
2288            msg = "Please select a Model first..."
2289            wx.MessageBox(msg, 'Info')
2290            wx.PostEvent(self._manager.parent,
2291                         StatusEvent(status="Polydispersion: %s" % msg))
2292            return
2293
2294        self._reset_dispersity()
2295
2296        if self.model is None:
2297            self.model_disp.Hide()
2298            self.sizer4_4.Clear(True)
2299            return
2300
2301        if self.enable_disp.GetValue():
2302            # layout for model containing no dispersity parameters
2303
2304            self.disp_list = self.model.getDispParamList()
2305
2306            if len(self.disp_list) == 0 and len(self.disp_cb_dict) == 0:
2307                self._layout_sizer_noDipers()
2308            else:
2309                # set gaussian sizer
2310                self._on_select_Disp(event=None)
2311        else:
2312            self.sizer4_4.Clear(True)
2313
2314        # post state to fit panel
2315        self.save_current_state()
2316        if event is not None:
2317            event = PageInfoEvent(page=self)
2318            wx.PostEvent(self.parent, event)
2319        # draw the model with the current dispersity
2320
2321        # Wojtek P, Oct 8, 2016: Calling draw_model seems to be unessecary.
2322        # By comenting it we save an extra Iq calculation
2323        # self._draw_model()
2324
2325        # Need to use FitInside again here to replace the next four lines.
2326        # Otherwised polydispersity off does not resize the scrollwindow.
2327        # PDB Nov 28, 2015
2328        self.FitInside()
2329#        self.sizer4_4.Layout()
2330#        self.sizer5.Layout()
2331#        self.Layout()
2332#        self.Refresh()
2333
2334    def _layout_sizer_noDipers(self):
2335        """
2336        Draw a sizer with no dispersity info
2337        """
2338        ix = 0
2339        iy = 1
2340        self.fittable_param = []
2341        self.fixed_param = []
2342        self.orientation_params_disp = []
2343
2344        self.sizer4_4.Clear(True)
2345        text = "No polydispersity available for this model"
2346        model_disp = wx.StaticText(self, wx.ID_ANY, text)
2347        self.sizer4_4.Add(model_disp, (iy, ix), (1, 1),
2348                          wx.LEFT | wx.EXPAND | wx.ADJUST_MINSIZE, 10)
2349        self.sizer4_4.Layout()
2350        self.sizer4.Layout()
2351
2352    def _reset_dispersity(self):
2353        """
2354        put gaussian dispersity into current model
2355        """
2356        if len(self.param_toFit) > 0:
2357            for item in self.fittable_param:
2358                if item in self.param_toFit:
2359                    self.param_toFit.remove(item)
2360
2361            for item in self.orientation_params_disp:
2362                if item in self.param_toFit:
2363                    self.param_toFit.remove(item)
2364
2365        self.fittable_param = []
2366        self.fixed_param = []
2367        self.orientation_params_disp = []
2368        self.values = {}
2369        self.weights = {}
2370
2371        # from sas.models.dispersion_models import GaussianDispersion
2372        from sasmodels.weights import GaussianDispersion
2373        if len(self.disp_cb_dict) == 0:
2374            self.save_current_state()
2375            self.sizer4_4.Clear(True)
2376            self.Layout()
2377            return
2378        if (len(self.disp_cb_dict) > 0):
2379            for p in self.disp_cb_dict:
2380                # The parameter was un-selected.
2381                # Go back to Gaussian model (with 0 pts)
2382                disp_model = GaussianDispersion()
2383
2384                self._disp_obj_dict[p] = disp_model
2385                # Set the new model as the dispersion object
2386                # for the selected parameter
2387                try:
2388                    self.model.set_dispersion(p, disp_model)
2389                except Exception:
2390                    logging.error(traceback.format_exc())
2391
2392        # save state into
2393        self.save_current_state()
2394        self.Layout()
2395        self.Refresh()
2396
2397    def _on_select_Disp(self, event):
2398        """
2399        allow selecting different dispersion
2400        self.disp_list should change type later .now only gaussian
2401        """
2402        self._set_sizer_dispersion()
2403
2404        # Redraw the model
2405        #  Wojtek P. Nov 7, 2016: Redrawing seems to be unnecessary here
2406        # self._draw_model()
2407        # self._undo.Enable(True)
2408        event = PageInfoEvent(page=self)
2409        wx.PostEvent(self.parent, event)
2410
2411        self.sizer4_4.Layout()
2412        self.sizer4.Layout()
2413        self.SetupScrolling()
2414
2415    def _on_disp_func(self, event=None):
2416        """
2417        Select a distribution function for the polydispersion
2418
2419        :Param event: ComboBox event
2420        """
2421        # get ready for new event
2422        if event is not None:
2423            event.Skip()
2424        # Get event object
2425        disp_box = event.GetEventObject()
2426
2427        # Try to select a Distr. function
2428        try:
2429            disp_box.SetBackgroundColour("white")
2430            selection = disp_box.GetCurrentSelection()
2431            param_name = disp_box.Name.split('.')[0]
2432            disp_name = disp_box.GetValue()
2433            dispersity = disp_box.GetClientData(selection)
2434
2435            # disp_model =  GaussianDispersion()
2436            disp_model = dispersity()
2437            # Get param names to reset the values of the param
2438            name1 = param_name + ".width"
2439            name2 = param_name + ".npts"
2440            name3 = param_name + ".nsigmas"
2441            # Check Disp. function whether or not it is 'array'
2442            if disp_name.lower() == "array":
2443                value2 = ""
2444                value3 = ""
2445                value1 = self._set_array_disp(name=name1, disp=disp_model)
2446            else:
2447                self._del_array_values(name1)
2448                # self._reset_array_disp(param_name)
2449                self._disp_obj_dict[name1] = disp_model
2450                self.model.set_dispersion(param_name, disp_model)
2451                self.state._disp_obj_dict[name1] = disp_model.type
2452
2453                value1 = str(format_number(self.model.getParam(name1), True))
2454                value2 = str(format_number(self.model.getParam(name2)))
2455                value3 = str(format_number(self.model.getParam(name3)))
2456            # Reset fittable polydispersin parameter value
2457            for item in self.fittable_param:
2458                if item[1] == name1:
2459                    item[2].SetValue(value1)
2460                    item[5].SetValue("")
2461                    item[6].SetValue("")
2462                    # Disable for array
2463                    if disp_name.lower() == "array":
2464                        item[0].SetValue(False)
2465                        item[0].Disable()
2466                        item[2].Disable()
2467                        item[3].Show(False)
2468                        item[4].Show(False)
2469                        item[5].Disable()
2470                        item[6].Disable()
2471                    else:
2472                        item[0].Enable()
2473                        item[2].Enable()
2474                        item[3].Show(True)
2475                        item[4].Show(True)
2476                        item[5].Enable()
2477                        item[6].Enable()
2478                    break
2479            # Reset fixed polydispersion params
2480            for item in self.fixed_param:
2481                if item[1] == name2:
2482                    item[2].SetValue(value2)
2483                    # Disable Npts for array
2484                    if disp_name.lower() == "array":
2485                        item[2].Disable()
2486                    else:
2487                        item[2].Enable()
2488                if item[1] == name3:
2489                    item[2].SetValue(value3)
2490                    # Disable Nsigs for array
2491                    if disp_name.lower() == "array":
2492                        item[2].Disable()
2493                    else:
2494                        item[2].Enable()
2495
2496            # Make sure the check box updated
2497            self.get_all_checked_params()
2498
2499            # update params
2500            self._update_paramv_on_fit()
2501            # draw
2502            self._draw_model()
2503            self.Refresh()
2504        except Exception:
2505            logging.error(traceback.format_exc())
2506            # Error msg
2507            msg = "Error occurred:"
2508            msg += " Could not select the distribution function..."
2509            msg += " Please select another distribution function."
2510            disp_box.SetBackgroundColour("pink")
2511            # Focus on Fit button so that users can see the pinky box
2512            self.btFit.SetFocus()
2513            wx.PostEvent(self._manager.parent,
2514                         StatusEvent(status=msg, info="error"))
2515
2516    def _set_array_disp(self, name=None, disp=None):
2517        """
2518        Set array dispersion
2519
2520        :param name: name of the parameter for the dispersion to be set
2521        :param disp: the polydisperion object
2522        """
2523        # The user wants this parameter to be averaged.
2524        # Pop up the file selection dialog.
2525        path = self._selectDlg()
2526        # Array data
2527        values = []
2528        weights = []
2529        # If nothing was selected, just return
2530        if path is None:
2531            self.disp_cb_dict[name].SetValue(False)
2532            # self.noDisper_rbox.SetValue(True)
2533            return
2534        self._default_save_location = os.path.dirname(path)
2535        if self._manager is not None:
2536            self._manager.parent._default_save_location = \
2537                             self._default_save_location
2538
2539        basename = os.path.basename(path)
2540        values, weights = self.read_file(path)
2541
2542        # If any of the two arrays is empty, notify the user that we won't
2543        # proceed
2544        if len(self.param_toFit) > 0:
2545            if name in self.param_toFit:
2546                self.param_toFit.remove(name)
2547
2548        # Tell the user that we are about to apply the distribution
2549        msg = "Applying loaded %s distribution: %s" % (name, path)
2550        wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
2551        self._set_array_disp_model(name=name, disp=disp,
2552                                   values=values, weights=weights)
2553        return basename
2554
2555    def _set_array_disp_model(self, name=None, disp=None,
2556                              values=[], weights=[]):
2557        """
2558        Set array dispersion model
2559
2560        :param name: name of the parameter for the dispersion to be set
2561        :param disp: the polydisperion object
2562        """
2563        disp.set_weights(values, weights)
2564        self._disp_obj_dict[name] = disp
2565        self.model.set_dispersion(name.split('.')[0], disp)
2566        self.state._disp_obj_dict[name] = disp.type
2567        self.values[name] = values
2568        self.weights[name] = weights
2569        # Store the object to make it persist outside the
2570        # scope of this method
2571        # TODO: refactor model to clean this up?
2572        self.state.values = {}
2573        self.state.weights = {}
2574        self.state.values = copy.deepcopy(self.values)
2575        self.state.weights = copy.deepcopy(self.weights)
2576
2577        # Set the new model as the dispersion object for the
2578        # selected parameter
2579        # self.model.set_dispersion(p, disp_model)
2580        # Store a reference to the weights in the model object
2581        # so that
2582        # it's not lost when we use the model within another thread.
2583        self.state.model = self.model.clone()
2584        self.model._persistency_dict[name.split('.')[0]] = \
2585            [values, weights]
2586        self.state.model._persistency_dict[name.split('.')[0]] = \
2587            [values, weights]
2588
2589    def _del_array_values(self, name=None):
2590        """
2591        Reset array dispersion
2592
2593        :param name: name of the parameter for the dispersion to be set
2594        """
2595        # Try to delete values and weight of the names array dic if exists
2596        try:
2597            if name in self.values:
2598                del self.values[name]
2599                del self.weights[name]
2600                # delete all other dic
2601                del self.state.values[name]
2602                del self.state.weights[name]
2603                del self.model._persistency_dict[name.split('.')[0]]
2604                del self.state.model._persistency_dict[name.split('.')[0]]
2605        except Exception:
2606            logging.error(traceback.format_exc())
2607
2608    def _lay_out(self):
2609        """
2610        returns self.Layout
2611
2612        :Note: Mac seems to like this better when self.
2613            Layout is called after fitting.
2614        """
2615        self._sleep4sec()
2616        self.Layout()
2617        return
2618
2619    def _sleep4sec(self):
2620        """
2621            sleep for 1 sec only applied on Mac
2622            Note: This 1sec helps for Mac not to crash on self.
2623            Layout after self._draw_model
2624        """
2625        if ON_MAC is True:
2626            time.sleep(1)
2627
2628    def _find_polyfunc_selection(self, disp_func=None):
2629        """
2630        FInd Comboox selection from disp_func
2631
2632        :param disp_function: dispersion distr. function
2633        """
2634        # Find the selection
2635        if disp_func is not None:
2636            try:
2637                return POLYDISPERSITY_MODELS.values().index(disp_func.__class__)
2638            except ValueError:
2639                pass  # Fall through to default class
2640        return POLYDISPERSITY_MODELS.keys().index('gaussian')
2641
2642    def on_reset_clicked(self, event):
2643        """
2644        On 'Reset' button  for Q range clicked
2645        """
2646        flag = True
2647        # For 3 different cases: Data2D, Data1D, and theory
2648        if self.model is None:
2649            msg = "Please select a model first..."
2650            wx.MessageBox(msg, 'Info')
2651            flag = False
2652            return
2653
2654        elif self.data.__class__.__name__ == "Data2D":
2655            data_min = 0
2656            x = max(math.fabs(self.data.xmin), math.fabs(self.data.xmax))
2657            y = max(math.fabs(self.data.ymin), math.fabs(self.data.ymax))
2658            self.qmin_x = data_min
2659            self.qmax_x = math.sqrt(x * x + y * y)
2660            # self.data.mask = numpy.ones(len(self.data.data),dtype=bool)
2661            # check smearing
2662            if not self.disable_smearer.GetValue():
2663                # set smearing value whether or
2664                # not the data contain the smearing info
2665                if self.pinhole_smearer.GetValue():
2666                    flag = self.update_pinhole_smear()
2667                else:
2668                    flag = True
2669
2670        elif self.data is None:
2671            self.qmin_x = _QMIN_DEFAULT
2672            self.qmax_x = _QMAX_DEFAULT
2673            self.num_points = _NPTS_DEFAULT
2674            self.state.npts = self.num_points
2675
2676        elif self.data.__class__.__name__ != "Data2D":
2677            self.qmin_x = min(self.data.x)
2678            self.qmax_x = max(self.data.x)
2679            # check smearing
2680            if not self.disable_smearer.GetValue():
2681                # set smearing value whether or
2682                # not the data contain the smearing info
2683                if self.slit_smearer.GetValue():
2684                    flag = self.update_slit_smear()
2685                elif self.pinhole_smearer.GetValue():
2686                    flag = self.update_pinhole_smear()
2687                else:
2688                    flag = True
2689        else:
2690            flag = False
2691
2692        if flag is False:
2693            msg = "Cannot Plot :Must enter a number!!!  "
2694            wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
2695        else:
2696            # set relative text ctrs.
2697            self.qmin.SetValue(str(self.qmin_x))
2698            self.qmax.SetValue(str(self.qmax_x))
2699            self.show_npts2fit()
2700            # At this point, some button and variables satatus (disabled?)
2701            # should be checked such as color that should be reset to
2702            # white in case that it was pink.
2703            self._onparamEnter_helper()
2704
2705        self.save_current_state()
2706        self.state.qmin = self.qmin_x
2707        self.state.qmax = self.qmax_x
2708
2709        # reset the q range values
2710        self._reset_plotting_range(self.state)
2711        self._draw_model()
2712
2713    def select_log(self, event):
2714        """
2715        Log checked to generate log spaced points for theory model
2716        """
2717
2718    def get_images(self):
2719        """
2720        Get the images of the plots corresponding this panel for report
2721
2722        : return graphs: list of figures
2723        : Need Move to guiframe
2724        """
2725        # set list of graphs
2726        graphs = []
2727        canvases = []
2728        res_item = None
2729        # call gui_manager
2730        gui_manager = self._manager.parent
2731        # loops through the panels [dic]
2732        for _, item2 in gui_manager.plot_panels.iteritems():
2733            data_title = self.data.group_id
2734            # try to get all plots belonging to this control panel
2735            try:
2736                g_id = item2.group_id
2737                if g_id == data_title or \
2738                        str(g_id).count("res" + str(self.graph_id)) or \
2739                        str(g_id).count(str(self.uid)) > 0:
2740                    if str(g_id).count("res" + str(self.graph_id)) > 0:
2741                        res_item = [item2.figure, item2.canvas]
2742                    else:
2743                        # append to the list
2744                        graphs.append(item2.figure)
2745                        canvases.append(item2.canvas)
2746            except Exception:
2747                # Not for control panels
2748                logging.error(traceback.format_exc())
2749        # Make sure the resduals plot goes to the last
2750        if res_item is not None:
2751            graphs.append(res_item[0])
2752            canvases.append(res_item[1])
2753        # return the list of graphs
2754        return graphs, canvases
2755
2756    def on_function_help_clicked(self, event):
2757        """
2758        Function called when 'Help' button is pressed next to model
2759        of interest.  This calls DocumentationWindow from
2760        documentation_window.py. It will load the top level of the model
2761        help documenation sphinx generated html if no model is presented.
2762        If a model IS present then if documention for that model exists
2763        it will load to that  point otherwise again it will go to the top.
2764        For Wx2.8 and below is used (i.e. non-released through installer)
2765        a browser is loaded and the top of the model documentation only is
2766        accessible because webbrowser module does not pass anything after
2767        the # to the browser.
2768
2769        :param event: on Help Button pressed event
2770        """
2771
2772        if self.model is not None:
2773            name = self.formfactorbox.GetValue()
2774            _TreeLocation = 'user/models/' + name.lower()+'.html'
2775            _doc_viewer = DocumentationWindow(self, wx.ID_ANY, _TreeLocation,
2776                                              "", name + " Help")
2777        else:
2778            _TreeLocation = 'user/index.html'
2779            _doc_viewer = DocumentationWindow(self, wx.ID_ANY, _TreeLocation,
2780                                              "", "General Model Help")
2781
2782    def on_model_help_clicked(self, event):
2783        """
2784        Function called when 'Description' button is pressed next to model
2785        of interest.  This calls the Description embedded in the model. This
2786        should work with either Wx2.8 and lower or higher. If no model is
2787        selected it will give the message that a model must be chosen first
2788        in the box that would normally contain the description.  If a badly
2789        behaved model is encountered which has no description then it will
2790        give the message that none is available.
2791
2792        :param event: on Description Button pressed event
2793        """
2794
2795        if self.model is None:
2796            name = 'index.html'
2797        else:
2798            name = self.formfactorbox.GetValue()
2799
2800        msg = 'Model description:\n'
2801        info = "Info"
2802        if self.model is not None:
2803            # frame.Destroy()
2804            if str(self.model.description).rstrip().lstrip() == '':
2805                msg += "Sorry, no information is available for this model."
2806            else:
2807                msg += self.model.description + '\n'
2808            wx.MessageBox(msg, info)
2809        else:
2810            msg += "You must select a model to get information on this"
2811            wx.MessageBox(msg, info)
2812
2813    def _on_mag_angle_help(self, event):
2814        """
2815        Bring up Magnetic Angle definition bmp image whenever the ? button
2816        is clicked. Calls DocumentationWindow with the path of the location
2817        within the documentation tree (after /doc/ ....". When using old
2818        versions of Wx (i.e. before 2.9 and therefore not part of release
2819        versions distributed via installer) it brings up an image viewer
2820        box which allows the user to click through the rest of the images in
2821        the directory.  Not ideal but probably better than alternative which
2822        would bring up the entire discussion of how magnetic models work?
2823        Specially since it is not likely to be accessed.  The normal release
2824        versions bring up the normal image box.
2825
2826        :param evt: Triggers on clicking ? in Magnetic Angles? box
2827        """
2828
2829        _TreeLocation = "_images/M_angles_pic.bmp"
2830        _doc_viewer = DocumentationWindow(self, wx.ID_ANY, _TreeLocation, "",
2831                                          "Magnetic Angle Defintions")
2832
2833    def _on_mag_help(self, event):
2834        """
2835        Bring up Magnetic Angle definition bmp image whenever the ? button
2836        is clicked. Calls DocumentationWindow with the path of the location
2837        within the documentation tree (after /doc/ ....". When using old
2838        versions of Wx (i.e. before 2.9 and therefore not part of release
2839        versions distributed via installer) it brings up an image viewer
2840        box which allows the user to click through the rest of the images in
2841        the directory.  Not ideal but probably better than alternative which
2842        would bring up the entire discussion of how magnetic models work?
2843        Specially since it is not likely to be accessed.  The normal release
2844        versions bring up the normal image box.
2845
2846        :param evt: Triggers on clicking ? in Magnetic Angles? box
2847        """
2848
2849        _TreeLocation = "user/magnetism.html"
2850        _doc_viewer = DocumentationWindow(self, wx.ID_ANY, _TreeLocation, "",
2851                                          "Polarized Beam/Magnetc Help")
2852
2853    def _on_mag_on(self, event):
2854        """
2855        Magnetic Parameters ON/OFF
2856        """
2857        button = event.GetEventObject()
2858
2859        if button.GetLabel().count('ON') > 0:
2860            self.magnetic_on = True
2861            button.SetLabel("Magnetic OFF")
2862            m_value = 1.0e-06
2863            for key in self.model.magnetic_params:
2864                if key.count('M0') > 0:
2865                    self.model.setParam(key, m_value)
2866                    m_value += 0.5e-06
2867        else:
2868            self.magnetic_on = False
2869            button.SetLabel("Magnetic ON")
2870            for key in self.model.magnetic_params:
2871                if key.count('M0') > 0:
2872                    # reset mag value to zero fo safety
2873                    self.model.setParam(key, 0.0)
2874
2875        self.Show(False)
2876        self.set_model_param_sizer(self.model)
2877        # self._set_sizer_dispersion()
2878        self.state.magnetic_on = self.magnetic_on
2879        self.SetupScrolling()
2880        self.Show(True)
2881
2882    def on_pd_help_clicked(self, event):
2883        """
2884        Bring up Polydispersity Documentation whenever the ? button is clicked.
2885        Calls DocumentationWindow with the path of the location within the
2886        documentation tree (after /doc/ ....".  Note that when using old
2887        versions of Wx (before 2.9) and thus not the release version of
2888        istallers, the help comes up at the top level of the file as
2889        webbrowser does not pass anything past the # to the browser when it is
2890        running "file:///...."
2891
2892        :param event: Triggers on clicking ? in polydispersity box
2893        """
2894
2895        _TreeLocation = "user/sasgui/perspectives/fitting/pd_help.html"
2896        _PageAnchor = ""
2897        _doc_viewer = DocumentationWindow(self, wx.ID_ANY, _TreeLocation,
2898                                          _PageAnchor, "Polydispersity Help")
2899
2900    def on_left_down(self, event):
2901        """
2902        Get key stroke event
2903        """
2904        # Figuring out key combo: Cmd for copy, Alt for paste
2905        if event.CmdDown() and event.ShiftDown():
2906            self.get_paste()
2907        elif event.CmdDown():
2908            self.get_copy()
2909        else:
2910            event.Skip()
2911            return
2912        # make event free
2913        event.Skip()
2914
2915    def get_copy(self):
2916        """
2917        Get copy params to clipboard
2918        """
2919        content = self.get_copy_params()
2920        flag = self.set_clipboard(content)
2921        self._copy_info(flag)
2922        return flag
2923
2924    def get_copy_params(self):
2925        """
2926        Get the string copies of the param names and values in the tap
2927        """
2928        content = 'sasview_parameter_values:'
2929        # Do it if params exist
2930        if self.parameters:
2931
2932            # go through the parameters
2933            strings = self._get_copy_helper(self.parameters,
2934                                           self.orientation_params)
2935            content += strings
2936
2937            # go through the fittables
2938            strings = self._get_copy_helper(self.fittable_param,
2939                                           self.orientation_params_disp)
2940            content += strings
2941
2942            # go through the fixed params
2943            strings = self._get_copy_helper(self.fixed_param,
2944                                           self.orientation_params_disp)
2945            content += strings
2946
2947            # go through the str params
2948            strings = self._get_copy_helper(self.str_parameters,
2949                                           self.orientation_params)
2950            content += strings
2951            return content
2952        else:
2953            return False
2954
2955    def get_copy_excel(self):
2956        """
2957        Get copy params to clipboard
2958        """
2959        content = self.get_copy_params_excel()
2960        flag = self.set_clipboard(content)
2961        self._copy_info(flag)
2962        return flag
2963
2964    def get_copy_params_excel(self):
2965        """
2966        Get the string copies of the param names and values in the tap
2967        """
2968        content = ''
2969
2970        crlf = chr(13) + chr(10)
2971        tab = chr(9)
2972
2973        # Do it if params exist
2974        if self.parameters:
2975
2976            for param in self.parameters:
2977                content += param[1]  # parameter name
2978                content += tab
2979                content += param[1] + "_err"
2980                content += tab
2981
2982            content += crlf
2983
2984            # row of values and errors...
2985            for param in self.parameters:
2986                content += param[2].GetValue()  # value
2987                content += tab
2988                content += param[4].GetValue()  # error
2989                content += tab
2990
2991            return content
2992        else:
2993            return False
2994
2995    def get_copy_latex(self):
2996        """
2997        Get copy params to clipboard
2998        """
2999        content = self.get_copy_params_latex()
3000        flag = self.set_clipboard(content)
3001        self._copy_info(flag)
3002        return flag
3003
3004    def get_copy_params_latex(self):
3005        """
3006        Get the string copies of the param names and values in the tap
3007        """
3008        content = '\\begin{table}'
3009        content += '\\begin{tabular}[h]'
3010
3011        crlf = chr(13) + chr(10)
3012        tab = chr(9)
3013
3014        # Do it if params exist
3015        if self.parameters:
3016
3017            content += '{|'
3018            for param in self.parameters:
3019                content += 'l|l|'
3020            content += '}\hline'
3021            content += crlf
3022
3023            for index, param in enumerate(self.parameters):
3024                content += param[1].replace('_', '\_')  # parameter name
3025                content += ' & '
3026                content += param[1].replace('_', '\_') + "\_err"
3027                if index < len(self.parameters) - 1:
3028                    content += ' & '
3029            content += '\\\\ \\hline'
3030            content += crlf
3031
3032            # row of values and errors...
3033            for index, param in enumerate(self.parameters):
3034                content += param[2].GetValue()  # parameter value
3035                content += ' & '
3036                content += param[4].GetValue()  # parameter error
3037                if index < len(self.parameters) - 1:
3038                    content += ' & '
3039            content += '\\\\ \\hline'
3040            content += crlf
3041
3042            content += '\\end{tabular}'
3043            content += '\\end{table}'
3044            return content
3045        else:
3046            return False
3047
3048    def set_clipboard(self, content=None):
3049        """
3050        Put the string to the clipboard
3051        """
3052        if not content:
3053            return False
3054        if wx.TheClipboard.Open():
3055            wx.TheClipboard.SetData(wx.TextDataObject(str(content)))
3056            wx.TheClipboard.Close()
3057            return True
3058        return None
3059
3060    def _get_copy_helper(self, param, orient_param):
3061        """
3062        Helping get value and name of the params
3063
3064        : param param:  parameters
3065        : param orient_param = oritational params
3066        : return content: strings [list] [name,value:....]
3067        """
3068        content = ''
3069        bound_hi = ''
3070        bound_lo = ''
3071        # go through the str params
3072        for item in param:
3073            # copy only the params shown
3074            if not item[2].IsShown():
3075                continue
3076            disfunc = ''
3077            try:
3078                if item[7].__class__.__name__ == 'ComboBox':
3079                    disfunc = str(item[7].GetValue())
3080            except Exception:
3081                logging.error(traceback.format_exc())
3082
3083            # 2D
3084            if self.data.__class__.__name__ == "Data2D":
3085                try:
3086                    check = item[0].GetValue()
3087                except Exception:
3088                    check = None
3089                name = item[1]
3090                value = item[2].GetValue()
3091            # 1D
3092            else:
3093                # for 1D all parameters except orientation
3094                if not item[1] in orient_param:
3095                    try:
3096                        check = item[0].GetValue()
3097                    except:
3098                        check = None
3099                    name = item[1]
3100                    value = item[2].GetValue()
3101
3102            # Bounds
3103            try:
3104                bound_lo = item[5].GetValue()
3105                bound_hi = item[6].GetValue()
3106            except Exception:
3107                # harmless - need to just pass
3108                pass
3109
3110            # add to the content
3111            if disfunc != '':
3112
3113                disfunc = ',' + disfunc
3114            # Need to support array func for copy/paste
3115            try:
3116                if disfunc.count('array') > 0:
3117                    disfunc += ','
3118                    for val in self.values[name]:
3119                        disfunc += ' ' + str(val)
3120                    disfunc += ','
3121                    for weight in self.weights[name]:
3122                        disfunc += ' ' + str(weight)
3123            except Exception:
3124                logging.error(traceback.format_exc())
3125            content += name + ',' + str(check) + ',' + value + disfunc + ',' + \
3126                       bound_lo + ',' + bound_hi + ':'
3127
3128        return content
3129
3130    def get_clipboard(self):
3131        """
3132        Get strings in the clipboard
3133        """
3134        text = ""
3135        # Get text from the clip board
3136        if wx.TheClipboard.Open():
3137            if wx.TheClipboard.IsSupported(wx.DataFormat(wx.DF_TEXT)):
3138                data = wx.TextDataObject()
3139                # get wx dataobject
3140                success = wx.TheClipboard.GetData(data)
3141                # get text
3142                if success:
3143                    text = data.GetText()
3144                else:
3145                    text = ''
3146            # close clipboard
3147            wx.TheClipboard.Close()
3148        return text
3149
3150    def get_paste(self):
3151        """
3152        Paste params from the clipboard
3153        """
3154        text = self.get_clipboard()
3155        flag = self.get_paste_params(text)
3156        self._copy_info(flag)
3157        return flag
3158
3159    def get_paste_params(self, text=''):
3160        """
3161        Get the string copies of the param names and values in the tap
3162        """
3163        context = {}
3164        # put the text into dictionary
3165        lines = text.split(':')
3166        if lines[0] != 'sasview_parameter_values':
3167            self._copy_info(False)
3168            return False
3169        for line in lines[1:-1]:
3170            if len(line) != 0:
3171                item = line.split(',')
3172                check = item[1]
3173                name = item[0]
3174                value = item[2]
3175                # Transfer the text to content[dictionary]
3176                context[name] = [check, value]
3177
3178                # limits
3179                limit_lo = item[3]
3180                context[name].append(limit_lo)
3181                limit_hi = item[4]
3182                context[name].append(limit_hi)
3183
3184            # ToDo: PlugIn this poly disp function for pasting
3185            try:
3186                poly_func = item[5]
3187                context[name].append(poly_func)
3188                try:
3189                    # take the vals and weights for  array
3190                    array_values = item[6].split(' ')
3191                    array_weights = item[7].split(' ')
3192                    val = [float(a_val) for a_val in array_values[1:]]
3193                    weit = [float(a_weit) for a_weit in array_weights[1:]]
3194
3195                    context[name].append(val)
3196                    context[name].append(weit)
3197                except:
3198                    raise
3199            except:
3200                poly_func = ''
3201                context[name].append(poly_func)
3202
3203        # Do it if params exist
3204        if self.parameters:
3205            # go through the parameters
3206            self._get_paste_helper(self.parameters,
3207                                   self.orientation_params, context)
3208
3209            # go through the fittables
3210            self._get_paste_helper(self.fittable_param,
3211                                   self.orientation_params_disp,
3212                                   context)
3213
3214            # go through the fixed params
3215            self._get_paste_helper(self.fixed_param,
3216                                   self.orientation_params_disp, context)
3217
3218            # go through the str params
3219            self._get_paste_helper(self.str_parameters,
3220                                   self.orientation_params, context)
3221
3222            return True
3223        return None
3224
3225    def _get_paste_helper(self, param, orient_param, content):
3226        """
3227        Helping set values of the params
3228
3229        : param param:  parameters
3230        : param orient_param: oritational params
3231        : param content: dictionary [ name, value: name1.value1,...]
3232        """
3233        # go through the str params
3234        for item in param:
3235            # 2D
3236            if self.data.__class__.__name__ == "Data2D":
3237                name = item[1]
3238                if name in content.keys():
3239                    values = content[name]
3240                    check = values[0]
3241                    pd = values[1]
3242
3243                    if name.count('.') > 0:
3244                        # If this is parameter.width, then pd may be a floating
3245                        # point value or it may be an array distribution.
3246                        # Nothing to do for parameter.npts or parameter.nsigmas.
3247                        try:
3248                            float(pd)
3249                            if name.endswith('.npts'):
3250                                pd = int(pd)
3251                        except Exception:
3252                            # continue
3253                            if not pd and pd != '':
3254                                continue
3255                    item[2].SetValue(str(pd))
3256                    if item in self.fixed_param and pd == '':
3257                        # Only array func has pd == '' case.
3258                        item[2].Enable(False)
3259                    else:
3260                        item[2].Enable(True)
3261                    if item[2].__class__.__name__ == "ComboBox":
3262                        if content[name][1] in self.model.fun_list:
3263                            fun_val = self.model.fun_list[content[name][1]]
3264                            self.model.setParam(name, fun_val)
3265                    try:
3266                        item[5].SetValue(str(values[-3]))
3267                        item[6].SetValue(str(values[-2]))
3268                    except Exception:
3269                        # passing as harmless non-update
3270                        pass
3271
3272                    value = content[name][1:]
3273                    self._paste_poly_help(item, value)
3274                    if check == 'True':
3275                        is_true = True
3276                    elif check == 'False':
3277                        is_true = False
3278                    else:
3279                        is_true = None
3280                    if is_true is not None:
3281                        item[0].SetValue(is_true)
3282            # 1D
3283            else:
3284                # for 1D all parameters except orientation
3285                if not item[1] in orient_param:
3286                    name = item[1]
3287                    if name in content.keys():
3288                        check = content[name][0]
3289                        # Avoid changing combox content
3290                        value = content[name][1:]
3291                        pd = value[0]
3292                        if name.count('.') > 0:
3293                            # If this is parameter.width, then pd may be a
3294                            # floating point value or it may be an array
3295                            # distribution. Nothing to do for parameter.npts or
3296                            # parameter.nsigmas.
3297                            try:
3298                                pd = float(pd)
3299                                if name.endswith('.npts'):
3300                                    pd = int(pd)
3301                            except:
3302                                # continue
3303                                if not pd and pd != '':
3304                                    continue
3305                        item[2].SetValue(str(pd))
3306                        if item in self.fixed_param and pd == '':
3307                            # Only array func has pd == '' case.
3308                            item[2].Enable(False)
3309                        else:
3310                            item[2].Enable(True)
3311                        if item[2].__class__.__name__ == "ComboBox":
3312                            if value[0] in self.model.fun_list:
3313                                fun_val = self.model.fun_list[value[0]]
3314                                self.model.setParam(name, fun_val)
3315                                # save state
3316                        try:
3317                            item[5].SetValue(str(value[-3]))
3318                            item[6].SetValue(str(value[-2]))
3319                        except Exception:
3320                            # passing as harmless non-update
3321                            pass
3322
3323                        self._paste_poly_help(item, value)
3324                        if check == 'True':
3325                            is_true = True
3326                        elif check == 'False':
3327                            is_true = False
3328                        else:
3329                            is_true = None
3330                        if is_true is not None:
3331                            item[0].SetValue(is_true)
3332
3333        self.select_param(event=None)
3334        self.Refresh()
3335
3336    def _paste_poly_help(self, item, value):
3337        """
3338        Helps get paste for poly function
3339
3340        *item* is the parameter name
3341
3342        *value* depends on which parameter is being processed, and whether it
3343        has array polydispersity.
3344
3345        For parameters without array polydispersity:
3346
3347            parameter => ['FLOAT', '']
3348            parameter.width => ['FLOAT', 'DISTRIBUTION', '']
3349            parameter.npts => ['FLOAT', '']
3350            parameter.nsigmas => ['FLOAT', '']
3351
3352        For parameters with array polydispersity:
3353
3354            parameter => ['FLOAT', '']
3355            parameter.width => ['FILENAME', 'array', [x1, ...], [w1, ...]]
3356            parameter.npts => ['FLOAT', '']
3357            parameter.nsigmas => ['FLOAT', '']
3358        """
3359        # Do nothing if not setting polydispersity
3360        if len(value[3]) == 0:
3361            return
3362
3363        try:
3364            name = item[7].Name
3365            param_name = name.split('.')[0]
3366            item[7].SetValue(value[1])
3367            selection = item[7].GetCurrentSelection()
3368            dispersity = item[7].GetClientData(selection)
3369            disp_model = dispersity()
3370
3371            if value[1] == 'array':
3372                pd_vals = numpy.array(value[2])
3373                pd_weights = numpy.array(value[3])
3374                if len(pd_vals) == 0 or len(pd_vals) != len(pd_weights):
3375                    msg = ("bad array distribution parameters for %s"
3376                           % param_name)
3377                    raise ValueError(msg)
3378                self._set_disp_cb(True, item=item)
3379                self._set_array_disp_model(name=name,
3380                                           disp=disp_model,
3381                                           values=pd_vals,
3382                                           weights=pd_weights)
3383            else:
3384                self._set_disp_cb(False, item=item)
3385                self._disp_obj_dict[name] = disp_model
3386                self.model.set_dispersion(param_name, disp_model)
3387                self.state._disp_obj_dict[name] = disp_model.type
3388                # TODO: It's not an array, why update values and weights?
3389                self.model._persistency_dict[param_name] = \
3390                    [self.values, self.weights]
3391                self.state.values = self.values
3392                self.state.weights = self.weights
3393
3394        except Exception:
3395            logging.error(traceback.format_exc())
3396            print "Error in BasePage._paste_poly_help: %s" % \
3397                  sys.exc_info()[1]
3398
3399    def _set_disp_cb(self, isarray, item):
3400        """
3401        Set cb for array disp
3402        """
3403        if isarray:
3404            item[0].SetValue(False)
3405            item[0].Enable(False)
3406            item[2].Enable(False)
3407            item[3].Show(False)
3408            item[4].Show(False)
3409            item[5].SetValue('')
3410            item[5].Enable(False)
3411            item[6].SetValue('')
3412            item[6].Enable(False)
3413        else:
3414            item[0].Enable()
3415            item[2].Enable()
3416            item[3].Show(True)
3417            item[4].Show(True)
3418            item[5].Enable()
3419            item[6].Enable()
3420
3421    def update_pinhole_smear(self):
3422        """
3423            Method to be called by sub-classes
3424            Moveit; This method doesn't belong here
3425        """
3426        print "BasicPage.update_pinhole_smear was called: skipping"
3427        return
3428
3429    def _read_category_info(self):
3430        """
3431        Reads the categories in from file
3432        """
3433        # # ILL mod starts here - July 2012 kieranrcampbell@gmail.com
3434        self.master_category_dict = defaultdict(list)
3435        self.by_model_dict = defaultdict(list)
3436        self.model_enabled_dict = defaultdict(bool)
3437        categorization_file = CategoryInstaller.get_user_file()
3438        with open(categorization_file, 'rb') as f:
3439            self.master_category_dict = json.load(f)
3440        self._regenerate_model_dict()
3441
3442    def _regenerate_model_dict(self):
3443        """
3444        regenerates self.by_model_dict which has each model name as the
3445        key and the list of categories belonging to that model
3446        along with the enabled mapping
3447        """
3448        self.by_model_dict = defaultdict(list)
3449        for category in self.master_category_dict:
3450            for (model, enabled) in self.master_category_dict[category]:
3451                self.by_model_dict[model].append(category)
3452                self.model_enabled_dict[model] = enabled
3453
3454    def _populate_listbox(self):
3455        """
3456        fills out the category list box
3457        """
3458        uncat_str = 'Customized Models'
3459        self._read_category_info()
3460
3461        self.categorybox.Clear()
3462        cat_list = sorted(self.master_category_dict.keys())
3463        if uncat_str not in cat_list:
3464            cat_list.append(uncat_str)
3465
3466        for category in cat_list:
3467            if category != '':
3468                self.categorybox.Append(category)
3469
3470        if self.categorybox.GetSelection() == wx.NOT_FOUND:
3471            self.categorybox.SetSelection(0)
3472        else:
3473            self.categorybox.SetSelection(
3474                self.categorybox.GetSelection())
3475        # self._on_change_cat(None)
3476
3477    def _on_change_cat(self, event):
3478        """
3479        Callback for category change action
3480        """
3481        self.model_name = None
3482        category = self.categorybox.GetStringSelection()
3483        if category is None:
3484            return
3485        self.model_box.Clear()
3486
3487        if category == 'Customized Models':
3488            for model in self.model_list_box[category]:
3489                str_m = str(model).split(".")[0]
3490                self.model_box.Append(str_m)
3491
3492        else:
3493            for (model, enabled) in sorted(self.master_category_dict[category],
3494                                           key=lambda name: name[0]):
3495                if(enabled):
3496                    self.model_box.Append(model)
3497
3498    def _fill_model_sizer(self, sizer):
3499        """
3500        fill sizer containing model info
3501        """
3502        # This should only be called once per fit tab
3503        # print "==== Entering _fill_model_sizer"
3504        # Add model function Details button in fitpanel.
3505        # The following 3 lines are for Mac. Let JHC know before modifying...
3506        title = "Model"
3507        self.formfactorbox = None
3508        self.multifactorbox = None
3509        self.mbox_description = wx.StaticBox(self, wx.ID_ANY, str(title))
3510        boxsizer1 = wx.StaticBoxSizer(self.mbox_description, wx.VERTICAL)
3511        sizer_cat = wx.BoxSizer(wx.HORIZONTAL)
3512        self.mbox_description.SetForegroundColour(wx.RED)
3513        wx_id = self._ids.next()
3514        self.model_func = wx.Button(self, wx_id, 'Help', size=(80, 23))
3515        self.model_func.Bind(wx.EVT_BUTTON, self.on_function_help_clicked,
3516                             id=wx_id)
3517        self.model_func.SetToolTipString("Full Model Function Help")
3518        wx_id = self._ids.next()
3519        self.model_help = wx.Button(self, wx_id, 'Description', size=(80, 23))
3520        self.model_help.Bind(wx.EVT_BUTTON, self.on_model_help_clicked,
3521                             id=wx_id)
3522        self.model_help.SetToolTipString("Short Model Function Description")
3523        wx_id = self._ids.next()
3524        self.model_view = wx.Button(self, wx_id, "Show 2D", size=(80, 23))
3525        self.model_view.Bind(wx.EVT_BUTTON, self._onModel2D, id=wx_id)
3526        hint = "toggle view of model from 1D to 2D  or 2D to 1D"
3527        self.model_view.SetToolTipString(hint)
3528
3529        cat_set_box = wx.StaticBox(self, wx.ID_ANY, 'Category')
3530        sizer_cat_box = wx.StaticBoxSizer(cat_set_box, wx.HORIZONTAL)
3531        sizer_cat_box.SetMinSize((200, 50))
3532        self.categorybox = wx.ComboBox(self, wx.ID_ANY,
3533                                       style=wx.CB_READONLY)
3534        self.categorybox.SetToolTip(wx.ToolTip("Select a Category/Type"))
3535        self._populate_listbox()
3536        wx.EVT_COMBOBOX(self.categorybox, wx.ID_ANY, self._show_combox)
3537        # self.shape_rbutton = wx.RadioButton(self, wx.ID_ANY, 'Shapes',
3538        #                                     style=wx.RB_GROUP)
3539        # self.shape_indep_rbutton = wx.RadioButton(self, wx.ID_ANY,
3540        #                                          "Shape-Independent")
3541        # self.struct_rbutton = wx.RadioButton(self, wx.ID_ANY,
3542        #                                     "Structure Factor ")
3543        # self.plugin_rbutton = wx.RadioButton(self, wx.ID_ANY,
3544        #                                     "Uncategorized")
3545
3546        # self.Bind(wx.EVT_RADIOBUTTON, self._show_combox,
3547        #                   id=self.shape_rbutton.GetId())
3548        # self.Bind(wx.EVT_RADIOBUTTON, self._show_combox,
3549        #                    id=self.shape_indep_rbutton.GetId())
3550        # self.Bind(wx.EVT_RADIOBUTTON, self._show_combox,
3551        #                    id=self.struct_rbutton.GetId())
3552        # self.Bind(wx.EVT_RADIOBUTTON, self._show_combox,
3553        #                    id=self.plugin_rbutton.GetId())
3554        # MAC needs SetValue
3555
3556        show_cat_button = wx.Button(self, wx.ID_ANY, "Modify")
3557        cat_tip = "Modify model categories \n"
3558        cat_tip += "(also accessible from the menu bar)."
3559        show_cat_button.SetToolTip(wx.ToolTip(cat_tip))
3560        show_cat_button.Bind(wx.EVT_BUTTON, self._on_modify_cat)
3561        sizer_cat_box.Add(self.categorybox, 1, wx.RIGHT, 3)
3562        sizer_cat_box.Add((10, 10))
3563        sizer_cat_box.Add(show_cat_button)
3564        # self.shape_rbutton.SetValue(True)
3565
3566        sizer_radiobutton = wx.GridSizer(2, 2, 5, 5)
3567        # sizer_radiobutton.Add(self.shape_rbutton)
3568        # sizer_radiobutton.Add(self.shape_indep_rbutton)
3569        sizer_radiobutton.Add((5, 5))
3570        sizer_radiobutton.Add(self.model_view, 1, wx.RIGHT, 5)
3571        # sizer_radiobutton.Add(self.plugin_rbutton)
3572        # sizer_radiobutton.Add(self.struct_rbutton)
3573        # sizer_radiobutton.Add((5,5))
3574        sizer_radiobutton.Add(self.model_help, 1, wx.RIGHT | wx.LEFT, 5)
3575        # sizer_radiobutton.Add((5,5))
3576        sizer_radiobutton.Add(self.model_func, 1, wx.RIGHT, 5)
3577        sizer_cat.Add(sizer_cat_box, 1, wx.LEFT, 2.5)
3578        sizer_cat.Add(sizer_radiobutton)
3579        sizer_selection = wx.BoxSizer(wx.HORIZONTAL)
3580        mutifactor_selection = wx.BoxSizer(wx.HORIZONTAL)
3581
3582        self.text1 = wx.StaticText(self, wx.ID_ANY, "")
3583        self.text2 = wx.StaticText(self, wx.ID_ANY, "P(Q)*S(Q)")
3584        self.mutifactor_text = wx.StaticText(self, wx.ID_ANY, "No. of Shells: ")
3585        self.mutifactor_text1 = wx.StaticText(self, wx.ID_ANY, "")
3586        self.show_sld_button = wx.Button(self, wx.ID_ANY, "Show SLD Profile")
3587        self.show_sld_button.Bind(wx.EVT_BUTTON, self._on_show_sld)
3588
3589        self.formfactorbox = wx.ComboBox(self, wx.ID_ANY, style=wx.CB_READONLY)
3590        self.formfactorbox.SetToolTip(wx.ToolTip("Select a Model"))
3591        if self.model is not None:
3592            self.formfactorbox.SetValue(self.model.name)
3593        self.structurebox = wx.ComboBox(self, wx.ID_ANY, style=wx.CB_READONLY)
3594        self.multifactorbox = wx.ComboBox(self, wx.ID_ANY, style=wx.CB_READONLY)
3595        self.initialize_combox()
3596        wx.EVT_COMBOBOX(self.formfactorbox, wx.ID_ANY, self._on_select_model)
3597
3598        wx.EVT_COMBOBOX(self.structurebox, wx.ID_ANY, self._on_select_model)
3599        wx.EVT_COMBOBOX(self.multifactorbox, wx.ID_ANY, self._on_select_model)
3600        # check model type to show sizer
3601        if self.model is not None:
3602            print "_set_model_sizer_selection: disabled."
3603            # self._set_model_sizer_selection(self.model)
3604
3605        sizer_selection.Add(self.text1)
3606        sizer_selection.Add((10, 5))
3607        sizer_selection.Add(self.formfactorbox)
3608        sizer_selection.Add((5, 5))
3609        sizer_selection.Add(self.text2)
3610        sizer_selection.Add((5, 5))
3611        sizer_selection.Add(self.structurebox)
3612
3613        mutifactor_selection.Add((13, 5))
3614        mutifactor_selection.Add(self.mutifactor_text)
3615        mutifactor_selection.Add(self.multifactorbox)
3616        mutifactor_selection.Add((5, 5))
3617        mutifactor_selection.Add(self.mutifactor_text1)
3618        mutifactor_selection.Add((10, 5))
3619        mutifactor_selection.Add(self.show_sld_button)
3620
3621        boxsizer1.Add(sizer_cat)
3622        boxsizer1.Add((10, 10))
3623        boxsizer1.Add(sizer_selection)
3624        boxsizer1.Add((10, 10))
3625        boxsizer1.Add(mutifactor_selection)
3626
3627        self._set_multfactor_combobox()
3628        self.multifactorbox.SetSelection(1)
3629        self.show_sld_button.Hide()
3630        sizer.Add(boxsizer1, 0, wx.EXPAND | wx.ALL, 10)
3631        sizer.Layout()
3632
3633    def on_smear_helper(self, update=False):
3634        """
3635        Help for onSmear if implemented
3636
3637        :param update: force or not to update
3638        """
3639    def reset_page(self, state, first=False):
3640        """
3641        reset the state  if implemented
3642        """
3643    def onSmear(self, event):
3644        """
3645        Create a smear object if implemented
3646        """
3647    def onPinholeSmear(self, event):
3648        """
3649        Create a custom pinhole smear object if implemented
3650        """
3651    def onSlitSmear(self, event):
3652        """
3653        Create a custom slit smear object if implemented
3654        """
3655    def update_slit_smear(self):
3656        """
3657        called by kill_focus on pinhole TextCntrl
3658        to update the changes if implemented
3659        """
3660    def select_param(self, event):
3661        """
3662        Select TextCtrl  checked if implemented
3663        """
3664    def set_data(self, data=None):
3665        """
3666        Sets data if implemented
3667        """
3668    def _is_2D(self):
3669        """
3670        Check if data_name is Data2D if implemented
3671        """
3672    def _on_select_model(self, event=None):
3673        """
3674        call back for model selection if implemented
3675        """
3676    def get_weight_flag(self):
3677        """
3678        Get flag corresponding to a given weighting dI data if implemented
3679        """
3680    def _set_sizer_dispersion(self):
3681        """
3682        draw sizer for dispersity if implemented
3683        """
3684    def get_all_checked_params(self):
3685        """
3686        Found all parameters current check and add them to list of parameters
3687        to fit if implemented
3688        """
3689    def show_npts2fit(self):
3690        """
3691        setValue Npts for fitting if implemented
3692        """
3693    def _onModel2D(self, event):
3694        """
3695        toggle view of model from 1D to 2D  or 2D from 1D if implemented
3696        """
3697
3698
3699class ModelTextCtrl(wx.TextCtrl):
3700    """
3701    Text control for model and fit parameters.
3702    Binds the appropriate events for user interactions.
3703    Default callback methods can be overwritten on initialization
3704
3705    :param kill_focus_callback: callback method for EVT_KILL_FOCUS event
3706    :param set_focus_callback:  callback method for EVT_SET_FOCUS event
3707    :param mouse_up_callback:   callback method for EVT_LEFT_UP event
3708    :param text_enter_callback: callback method for EVT_TEXT_ENTER event
3709
3710    """
3711    # Set to True when the mouse is clicked while whole string is selected
3712    full_selection = False
3713    # Call back for EVT_SET_FOCUS events
3714    _on_set_focus_callback = None
3715
3716    def __init__(self, parent, id=-1,
3717                 value=wx.EmptyString,
3718                 pos=wx.DefaultPosition,
3719                 size=wx.DefaultSize,
3720                 style=0,
3721                 validator=wx.DefaultValidator,
3722                 name=wx.TextCtrlNameStr,
3723                 kill_focus_callback=None,
3724                 set_focus_callback=None,
3725                 mouse_up_callback=None,
3726                 text_enter_callback=None):
3727
3728        wx.TextCtrl.__init__(self, parent, id, value, pos,
3729                             size, style, validator, name)
3730
3731        # Bind appropriate events
3732        self._on_set_focus_callback = parent.onSetFocus \
3733            if set_focus_callback is None else set_focus_callback
3734        self.Bind(wx.EVT_SET_FOCUS, self._on_set_focus)
3735        self.Bind(wx.EVT_KILL_FOCUS, self._silent_kill_focus
3736        if kill_focus_callback is None else kill_focus_callback)
3737        self.Bind(wx.EVT_TEXT_ENTER, parent._onparamEnter
3738        if text_enter_callback is None else text_enter_callback)
3739        if not ON_MAC:
3740            self.Bind(wx.EVT_LEFT_UP, self._highlight_text
3741            if mouse_up_callback is None else mouse_up_callback)
3742
3743    def _on_set_focus(self, event):
3744        """
3745        Catch when the text control is set in focus to highlight the whole
3746        text if necessary
3747
3748        :param event: mouse event
3749
3750        """
3751        event.Skip()
3752        self.full_selection = True
3753        return self._on_set_focus_callback(event)
3754
3755    def _highlight_text(self, event):
3756        """
3757        Highlight text of a TextCtrl only of no text has be selected
3758
3759        :param event: mouse event
3760
3761        """
3762        # Make sure the mouse event is available to other listeners
3763        event.Skip()
3764        control = event.GetEventObject()
3765        if self.full_selection:
3766            self.full_selection = False
3767            # Check that we have a TextCtrl
3768            if issubclass(control.__class__, wx.TextCtrl):
3769                # Check whether text has been selected,
3770                # if not, select the whole string
3771                (start, end) = control.GetSelection()
3772                if start == end:
3773                    control.SetSelection(-1, -1)
3774
3775    def _silent_kill_focus(self, event):
3776        """
3777        Save the state of the page
3778        """
3779
3780        event.Skip()
3781        # pass
Note: See TracBrowser for help on using the repository browser.