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

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 198fa76 was c8e1996, checked in by krzywon, 8 years ago

Fixes #738: No errors are thrown on loading projects with fits, plus linting.

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