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

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

Save states with 'Customized Models' category now load as 'Plugin Models' and created constants for both strings.

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