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

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 7a5aedd was 7a5aedd, checked in by krzywon, 7 years ago

Move 'Custom Models' to 'Plugin Models' to name conversion.

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