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

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

#795: Forward conversion of v3.0+ save states working for simple models, but requires testing of complex and reparameratized models.

  • Property mode set to 100644
File size: 142.0 KB
Line 
1"""
2Base Page for fitting
3"""
4import sys
5import os
6import wx
7import numpy
8import time
9import copy
10import math
11import json
12import logging
13import traceback
14
15from collections import defaultdict
16from wx.lib.scrolledpanel import ScrolledPanel
17
18from sasmodels.weights import MODELS as POLYDISPERSITY_MODELS
19
20from sas.sasgui.guiframe.panel_base import PanelBase
21from sas.sasgui.guiframe.utils import format_number, check_float, IdList, \
22    check_int
23from sas.sasgui.guiframe.events import PanelOnFocusEvent
24from sas.sasgui.guiframe.events import StatusEvent
25from sas.sasgui.guiframe.events import AppendBookmarkEvent
26from sas.sasgui.guiframe.dataFitting import Data2D
27from sas.sasgui.guiframe.dataFitting import Data1D
28from sas.sasgui.guiframe.dataFitting import check_data_validity
29from sas.sasgui.guiframe.gui_style import GUIFRAME_ID
30from sas.sascalc.dataloader.data_info import Detector
31from sas.sascalc.dataloader.data_info import Source
32from sas.sasgui.perspectives.fitting.pagestate import PageState
33from sas.sasgui.guiframe.CategoryInstaller import CategoryInstaller
34from sas.sasgui.guiframe.documentation_window import DocumentationWindow
35
36
37(PageInfoEvent, EVT_PAGE_INFO) = wx.lib.newevent.NewEvent()
38(PreviousStateEvent, EVT_PREVIOUS_STATE) = wx.lib.newevent.NewEvent()
39(NextStateEvent, EVT_NEXT_STATE) = wx.lib.newevent.NewEvent()
40
41_BOX_WIDTH = 76
42_QMIN_DEFAULT = 0.0005
43_QMAX_DEFAULT = 0.5
44_NPTS_DEFAULT = 50
45# Control panel width
46if sys.platform.count("win32") > 0:
47    PANEL_WIDTH = 450
48    FONT_VARIANT = 0
49    ON_MAC = False
50else:
51    PANEL_WIDTH = 500
52    FONT_VARIANT = 1
53    ON_MAC = True
54
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            if state.formfactorcombobox is not None:
1160                state._convert_to_sasmodels()
1161            state.categorycombobox = unicode(state.categorycombobox)
1162            if state.categorycombobox in self.categorybox.Items:
1163                category_pos = self.categorybox.Items.index(
1164                    state.categorycombobox)
1165            else:
1166                # Look in master list for model name (model.lower)
1167                category_pos = self.get_cat_combo_box_pos(state)
1168
1169        self.categorybox.Select(category_pos)
1170        self._show_combox(None)
1171        try:
1172            # to support older version
1173            formfactor_pos = int(state.formfactorcombobox)
1174        except:
1175            formfactor_pos = 0
1176            for ind_form in range(self.formfactorbox.GetCount()):
1177                if self.formfactorbox.GetString(ind_form) == \
1178                                                    (state.formfactorcombobox):
1179                    formfactor_pos = int(ind_form)
1180                    break
1181
1182        self.formfactorbox.Select(formfactor_pos)
1183
1184        structfactor_pos = 0
1185        try:
1186            # to support older version
1187            structfactor_pos = int(state.structurecombobox)
1188        except:
1189            if state.structurecombobox is not None:
1190                state.structurecombobox = unicode(state.structurecombobox)
1191                for ind_struct in range(self.structurebox.GetCount()):
1192                    if self.structurebox.GetString(ind_struct) == \
1193                                                    (state.structurecombobox):
1194                        structfactor_pos = int(ind_struct)
1195                        break
1196
1197        self.structurebox.SetSelection(structfactor_pos)
1198
1199        if state.multi_factor is not None:
1200            self.multifactorbox.SetSelection(state.multi_factor)
1201
1202        # draw the panel according to the new model parameter
1203        self._on_select_model(event=None)
1204
1205        # take care of 2D button
1206        if data is None and self.model_view.IsEnabled():
1207            if self.enable2D:
1208                self.model_view.SetLabel("2D Mode")
1209            else:
1210                self.model_view.SetLabel("1D Mode")
1211
1212        # reset state of checkbox,textcrtl  and  regular parameters value
1213        self._reset_parameters_state(self.orientation_params_disp,
1214                                     state.orientation_params_disp)
1215        self._reset_parameters_state(self.orientation_params,
1216                                     state.orientation_params)
1217        self._reset_parameters_state(self.str_parameters,
1218                                     state.str_parameters)
1219        self._reset_parameters_state(self.parameters, state.parameters)
1220        # display dispersion info layer
1221        self.enable_disp.SetValue(state.enable_disp)
1222        self.disable_disp.SetValue(state.disable_disp)
1223        # If the polydispersion is ON
1224        if state.enable_disp:
1225            # reset dispersion according the state
1226            self._set_dipers_Param(event=None)
1227            self._reset_page_disp_helper(state)
1228        # plotting range restore
1229        self._reset_plotting_range(state)
1230        # smearing info  restore
1231        if hasattr(self, "enable_smearer"):
1232            # set smearing value whether or not the data
1233            # contain the smearing info
1234            self.enable_smearer.SetValue(state.enable_smearer)
1235            self.disable_smearer.SetValue(state.disable_smearer)
1236            self.onSmear(event=None)
1237        self.pinhole_smearer.SetValue(state.pinhole_smearer)
1238        self.slit_smearer.SetValue(state.slit_smearer)
1239        try:
1240            self.dI_noweight.SetValue(state.dI_noweight)
1241            self.dI_didata.SetValue(state.dI_didata)
1242            self.dI_sqrdata.SetValue(state.dI_sqrdata)
1243            self.dI_idata.SetValue(state.dI_idata)
1244        except:
1245            # to support older state file formats
1246            self.dI_noweight.SetValue(False)
1247            self.dI_didata.SetValue(True)
1248            self.dI_sqrdata.SetValue(False)
1249            self.dI_idata.SetValue(False)
1250
1251        # we have two more options for smearing
1252        if self.pinhole_smearer.GetValue():
1253            self.dx_min = state.dx_min
1254            self.dx_max = state.dx_max
1255            if self.dx_min is not None:
1256                self.smear_pinhole_min.SetValue(str(self.dx_min))
1257            if self.dx_max is not None:
1258                self.smear_pinhole_max.SetValue(str(self.dx_max))
1259            self.onPinholeSmear(event=None)
1260        elif self.slit_smearer.GetValue():
1261            self.dxl = state.dxl
1262            self.dxw = state.dxw
1263            if self.dxl is not None:
1264                self.smear_slit_height.SetValue(str(self.dxl))
1265            if self.dxw is not None:
1266                self.smear_slit_width.SetValue(str(self.dxw))
1267            else:
1268                self.smear_slit_width.SetValue('')
1269            self.onSlitSmear(event=None)
1270
1271        # reset state of checkbox,textcrtl  and dispersity parameters value
1272        self._reset_parameters_state(self.fittable_param, state.fittable_param)
1273        self._reset_parameters_state(self.fixed_param, state.fixed_param)
1274
1275        # draw the model with previous parameters value
1276        self._onparamEnter_helper()
1277        # reset the value of chisqr when not consistent with the value computed
1278        self.tcChi.SetValue(str(self.state.tcChi))
1279        # reset context menu items
1280        self._reset_context_menu()
1281
1282        # set the value of the current state to the state given as parameter
1283        self.state = state.clone()
1284        self.state.m_name = self.m_name
1285
1286    def _reset_page_disp_helper(self, state):
1287        """
1288        Help to rest page for dispersions
1289        """
1290        keys = self.model.getParamList()
1291        for item in keys:
1292            if item in self.disp_list and \
1293                            item not in self.model.details:
1294                self.model.details[item] = ["", None, None]
1295        # for k,v in self.state.disp_cb_dict.iteritems():
1296        self.disp_cb_dict = copy.deepcopy(state.disp_cb_dict)
1297        self.state.disp_cb_dict = copy.deepcopy(state.disp_cb_dict)
1298        self.values = copy.deepcopy(state.values)
1299        self.weights = copy.deepcopy(state.weights)
1300
1301        for key, disp_type in state._disp_obj_dict.iteritems():
1302            # disp_model = disp
1303            disp_model = POLYDISPERSITY_MODELS[disp_type]()
1304            self._disp_obj_dict[key] = disp_model
1305            param_name = key.split('.')[0]
1306            # Try to set dispersion only when available
1307            # for eg., pass the orient. angles for 1D Cal
1308            try:
1309                self.model.set_dispersion(param_name, disp_model)
1310                self.model._persistency_dict[key] = \
1311                    [state.values, state.weights]
1312            except Exception:
1313                logging.error(traceback.format_exc())
1314            selection = self._find_polyfunc_selection(disp_model)
1315            for list in self.fittable_param:
1316                if list[1] == key and list[7] is not None:
1317                    list[7].SetSelection(selection)
1318                    # For the array disp_model, set the values and weights
1319                    if selection == 1:
1320                        disp_model.set_weights(self.values[key],
1321                                               self.weights[key])
1322                        try:
1323                            # Diables all fittable params for array
1324                            list[0].SetValue(False)
1325                            list[0].Disable()
1326                            list[2].Disable()
1327                            list[5].Disable()
1328                            list[6].Disable()
1329                        except Exception:
1330                            logging.error(traceback.format_exc())
1331            # For array, disable all fixed params
1332            if selection == 1:
1333                for item in self.fixed_param:
1334                    if item[1].split(".")[0] == key.split(".")[0]:
1335                        # try it and pass it for the orientation for 1D
1336                        try:
1337                            item[2].Disable()
1338                        except Exception:
1339                            logging.error(traceback.format_exc())
1340
1341    def _selectDlg(self):
1342        """
1343        open a dialog file to selected the customized dispersity
1344        """
1345        if self.parent is not None:
1346            self._default_save_location = \
1347                        self._manager.parent.get_save_location()
1348        dlg = wx.FileDialog(self, "Choose a weight file",
1349                            self._default_save_location, "",
1350                            "*.*", wx.OPEN)
1351        path = None
1352        if dlg.ShowModal() == wx.ID_OK:
1353            path = dlg.GetPath()
1354        dlg.Destroy()
1355        return path
1356
1357    def _reset_context_menu(self):
1358        """
1359        reset the context menu
1360        """
1361        ids = iter(self._id_pool)  # Reusing ids for context menu
1362        for name, _ in self.state.saved_states.iteritems():
1363            self.number_saved_state += 1
1364            # Add item in the context menu
1365            wx_id = ids.next()
1366            msg = 'Save model and state %g' % self.number_saved_state
1367            self.popUpMenu.Append(wx_id, name, msg)
1368            wx.EVT_MENU(self, wx_id, self.onResetModel)
1369
1370    def _reset_plotting_range(self, state):
1371        """
1372        Reset the plotting range to a given state
1373        """
1374        self.qmin.SetValue(str(state.qmin))
1375        self.qmax.SetValue(str(state.qmax))
1376
1377    def _save_typeOfmodel(self):
1378        """
1379        save radiobutton containing the type model that can be selected
1380        """
1381        # self.state.shape_rbutton = self.shape_rbutton.GetValue()
1382        # self.state.shape_indep_rbutton = self.shape_indep_rbutton.GetValue()
1383        # self.state.struct_rbutton = self.struct_rbutton.GetValue()
1384        # self.state.plugin_rbutton = self.plugin_rbutton.GetValue()
1385        self.state.structurecombobox = self.structurebox.GetLabel()
1386        self.state.formfactorcombobox = self.formfactorbox.GetLabel()
1387        self.state.categorycombobox = self.categorybox.GetLabel()
1388
1389        # post state to fit panel
1390        event = PageInfoEvent(page=self)
1391        wx.PostEvent(self.parent, event)
1392
1393    def _save_plotting_range(self):
1394        """
1395        save the state of plotting range
1396        """
1397        self.state.qmin = self.qmin_x
1398        self.state.qmax = self.qmax_x
1399        self.state.npts = self.npts_x
1400
1401    def _onparamEnter_helper(self, is_modified=False):
1402        """
1403        check if values entered by the user are changed and valid to replot
1404        model
1405        """
1406        # Flag to register when a parameter has changed.
1407        # is_modified = False
1408        self.fitrange = True
1409        is_2Ddata = False
1410        # self._undo.Enable(True)
1411        # check if 2d data
1412        if self.data.__class__.__name__ == "Data2D":
1413            is_2Ddata = True
1414        if self.model is not None:
1415            # Either we get a is_modified = True passed in because
1416            # _update_paramv_on_fit() has been called already or
1417            # we need to check here ourselves.
1418            if not is_modified:
1419                is_modified = (self._check_value_enter(self.fittable_param)
1420                               or self._check_value_enter(self.fixed_param)
1421                               or self._check_value_enter(self.parameters))
1422
1423            # Here we should check whether the boundaries have been modified.
1424            # If qmin and qmax have been modified, update qmin and qmax and
1425            # set the is_modified flag to True
1426            if self._validate_qrange(self.qmin, self.qmax):
1427                tempmin = float(self.qmin.GetValue())
1428                if tempmin != self.qmin_x:
1429                    self.qmin_x = tempmin
1430                    is_modified = True
1431                tempmax = float(self.qmax.GetValue())
1432                if tempmax != self.qmax_x:
1433                    self.qmax_x = tempmax
1434                    is_modified = True
1435
1436                if is_2Ddata:
1437                    # set mask
1438                    is_modified = self._validate_Npts()
1439
1440            else:
1441                self.fitrange = False
1442
1443            # if any value is modify draw model with new value
1444            if not self.fitrange:
1445                # self.btFit.Disable()
1446                if is_2Ddata:
1447                    self.btEditMask.Disable()
1448            else:
1449                if is_2Ddata and self.data.is_data and not self.batch_on:
1450                    self.btEditMask.Enable(True)
1451            if is_modified and self.fitrange:
1452                # Theory case: need to get npts value to draw
1453                self.npts_x = float(self.Npts_total.GetValue())
1454                self.create_default_data()
1455                self.state_change = True
1456                self._draw_model()
1457                self.Refresh()
1458
1459        # logging.info("is_modified flag set to %g",is_modified)
1460        return is_modified
1461
1462    def _update_paramv_on_fit(self):
1463        """
1464        make sure that update param values just before the fitting
1465        """
1466        # flag for qmin qmax check values
1467        flag = True
1468        self.fitrange = True
1469        is_modified = False
1470
1471        # wx.PostEvent(self._manager.parent, StatusEvent(status=" \
1472        # updating ... ",type="update"))
1473
1474        # So make sure that update param values on_Fit.
1475        # self._undo.Enable(True)
1476        if self.model is not None:
1477            if self.Npts_total.GetValue() != self.Npts_fit.GetValue():
1478                if not self.data.is_data:
1479                    self._manager.page_finder[self.uid].set_fit_data(
1480                        data=[self.data])
1481            # Check the values
1482            is_modified = (self._check_value_enter(self.fittable_param)
1483                           or self._check_value_enter(self.fixed_param)
1484                           or self._check_value_enter(self.parameters))
1485
1486            # If qmin and qmax have been modified, update qmin and qmax and
1487            # Here we should check whether the boundaries have been modified.
1488            # If qmin and qmax have been modified, update qmin and qmax and
1489            # set the is_modified flag to True
1490            self.fitrange = self._validate_qrange(self.qmin, self.qmax)
1491            if self.fitrange:
1492                tempmin = float(self.qmin.GetValue())
1493                if tempmin != self.qmin_x:
1494                    self.qmin_x = tempmin
1495                tempmax = float(self.qmax.GetValue())
1496                if tempmax != self.qmax_x:
1497                    self.qmax_x = tempmax
1498                if tempmax == tempmin:
1499                    flag = False
1500                temp_smearer = None
1501                if not self.disable_smearer.GetValue():
1502                    temp_smearer = self.current_smearer
1503                    if self.slit_smearer.GetValue():
1504                        flag = self.update_slit_smear()
1505                    elif self.pinhole_smearer.GetValue():
1506                        flag = self.update_pinhole_smear()
1507                    else:
1508                        enable_smearer = not self.disable_smearer.GetValue()
1509                        self._manager.set_smearer(smearer=temp_smearer,
1510                                                  uid=self.uid,
1511                                                  fid=self.data.id,
1512                                                  qmin=float(self.qmin_x),
1513                                                  qmax=float(self.qmax_x),
1514                                                  enable_smearer=enable_smearer,
1515                                                  draw=False)
1516                elif not self._is_2D():
1517                    enable_smearer = not self.disable_smearer.GetValue()
1518                    self._manager.set_smearer(smearer=temp_smearer,
1519                                              qmin=float(self.qmin_x),
1520                                              uid=self.uid,
1521                                              fid=self.data.id,
1522                                              qmax=float(self.qmax_x),
1523                                              enable_smearer=enable_smearer,
1524                                              draw=False)
1525                    if self.data is not None:
1526                        index_data = ((self.qmin_x <= self.data.x) &
1527                                      (self.data.x <= self.qmax_x))
1528                        val = str(len([index_data is True]))
1529                        self.Npts_fit.SetValue(val)
1530                    else:
1531                        # No data in the panel
1532                        try:
1533                            self.npts_x = float(self.Npts_total.GetValue())
1534                        except:
1535                            flag = False
1536                            return flag
1537                    flag = True
1538                if self._is_2D():
1539                    # only 2D case set mask
1540                    flag = self._validate_Npts()
1541                    if not flag:
1542                        return flag
1543            else:
1544                flag = False
1545        else:
1546            flag = False
1547
1548        # For invalid q range, disable the mask editor and fit button, vs.
1549        if not self.fitrange:
1550            if self._is_2D():
1551                self.btEditMask.Disable()
1552        else:
1553            if self._is_2D() and self.data.is_data and not self.batch_on:
1554                self.btEditMask.Enable(True)
1555
1556        if not flag:
1557            msg = "Cannot Plot or Fit :Must select a "
1558            msg += " model or Fitting range is not valid!!!  "
1559            wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1560
1561        try:
1562            self.save_current_state()
1563        except Exception:
1564            logging.error(traceback.format_exc())
1565
1566        return flag, is_modified
1567
1568    def _reset_parameters_state(self, listtorestore, statelist):
1569        """
1570        Reset the parameters at the given state
1571        """
1572        if len(statelist) == 0 or len(listtorestore) == 0:
1573            return
1574        if len(statelist) != len(listtorestore):
1575            return
1576
1577        ordered_list = []
1578        for i in range(len(listtorestore)) :
1579            for param in statelist:
1580                if param[1] == listtorestore[i][1]:
1581                    ordered_list.append(param)
1582                    break
1583        statelist = ordered_list
1584
1585        for j in range(len(listtorestore)):
1586            item_page = listtorestore[j]
1587            item_page_info = statelist[j]
1588            # change the state of the check box for simple parameters
1589            if item_page[0] is not None:
1590                item_page[0].SetValue(item_page_info[0])
1591            if item_page[2] is not None:
1592                item_page[2].SetValue(item_page_info[2])
1593                if item_page[2].__class__.__name__ == "ComboBox":
1594                    if item_page_info[2] in self.model.fun_list:
1595                        fun_val = self.model.fun_list[item_page_info[2]]
1596                        self.model.setParam(item_page_info[1], fun_val)
1597            if item_page[3] is not None:
1598                # show or hide text +/-
1599                if item_page_info[2]:
1600                    item_page[3].Show(True)
1601                else:
1602                    item_page[3].Hide()
1603            if item_page[4] is not None:
1604                # show of hide the text crtl for fitting error
1605                if item_page_info[4][0]:
1606                    item_page[4].Show(True)
1607                    item_page[4].SetValue(item_page_info[4][1])
1608                else:
1609                    item_page[3].Hide()
1610            if item_page[5] is not None:
1611                # show of hide the text crtl for fitting error
1612                item_page[5].Show(item_page_info[5][0])
1613                item_page[5].SetValue(item_page_info[5][1])
1614
1615            if item_page[6] is not None:
1616                # show of hide the text crtl for fitting error
1617                item_page[6].Show(item_page_info[6][0])
1618                item_page[6].SetValue(item_page_info[6][1])
1619
1620    def _reset_strparam_state(self, listtorestore, statelist):
1621        """
1622        Reset the string parameters at the given state
1623        """
1624        if len(statelist) == 0:
1625            return
1626
1627        listtorestore = copy.deepcopy(statelist)
1628
1629        for j in range(len(listtorestore)):
1630            item_page = listtorestore[j]
1631            item_page_info = statelist[j]
1632            # change the state of the check box for simple parameters
1633
1634            if item_page[0] is not None:
1635                item_page[0].SetValue(format_number(item_page_info[0], True))
1636
1637            if item_page[2] is not None:
1638                param_name = item_page_info[1]
1639                value = item_page_info[2]
1640                selection = value
1641                if value in self.model.fun_list:
1642                    selection = self.model.fun_list[value]
1643                item_page[2].SetValue(selection)
1644                self.model.setParam(param_name, selection)
1645
1646    def _copy_parameters_state(self, listtocopy, statelist):
1647        """
1648        copy the state of button
1649
1650        :param listtocopy: the list of check button to copy
1651        :param statelist: list of state object to store the current state
1652
1653        """
1654        if len(listtocopy) == 0:
1655            return
1656
1657        for item in listtocopy:
1658
1659            checkbox_state = None
1660            if item[0] is not None:
1661                checkbox_state = item[0].GetValue()
1662            parameter_name = item[1]
1663            parameter_value = None
1664            if item[2] is not None:
1665                parameter_value = item[2].GetValue()
1666            static_text = None
1667            if item[3] is not None:
1668                static_text = item[3].IsShown()
1669            error_value = None
1670            error_state = None
1671            if item[4] is not None:
1672                error_value = item[4].GetValue()
1673                error_state = item[4].IsShown()
1674
1675            min_value = None
1676            min_state = None
1677            if item[5] is not None:
1678                min_value = item[5].GetValue()
1679                min_state = item[5].IsShown()
1680
1681            max_value = None
1682            max_state = None
1683            if item[6] is not None:
1684                max_value = item[6].GetValue()
1685                max_state = item[6].IsShown()
1686            unit = None
1687            if item[7] is not None:
1688                unit = item[7].GetLabel()
1689
1690            statelist.append([checkbox_state, parameter_name, parameter_value,
1691                              static_text, [error_state, error_value],
1692                              [min_state, min_value],
1693                              [max_state, max_value], unit])
1694
1695    def _draw_model(self, update_chisqr=True, source='model'):
1696        """
1697        Method to draw or refresh a plotted model.
1698        The method will use the data member from the model page
1699        to build a call to the fitting perspective manager.
1700
1701        :param chisqr: update chisqr value [bool]
1702        """
1703        wx.CallAfter(self._draw_model_after, update_chisqr, source)
1704
1705    def _draw_model_after(self, update_chisqr=True, source='model'):
1706        """
1707        Method to draw or refresh a plotted model.
1708        The method will use the data member from the model page
1709        to build a call to the fitting perspective manager.
1710
1711        :param chisqr: update chisqr value [bool]
1712        """
1713        # if self.check_invalid_panel():
1714        #    return
1715        if self.model is not None:
1716            temp_smear = None
1717            if hasattr(self, "enable_smearer"):
1718                if not self.disable_smearer.GetValue():
1719                    temp_smear = self.current_smearer
1720            # compute weight for the current data
1721            from sas.sasgui.perspectives.fitting.utils import get_weight
1722            flag = self.get_weight_flag()
1723            weight = get_weight(data=self.data, is2d=self._is_2D(), flag=flag)
1724            toggle_mode_on = self.model_view.IsEnabled()
1725            is_2d = self._is_2D()
1726            self._manager.draw_model(self.model,
1727                                     data=self.data,
1728                                     smearer=temp_smear,
1729                                     qmin=float(self.qmin_x),
1730                                     qmax=float(self.qmax_x),
1731                                     page_id=self.uid,
1732                                     toggle_mode_on=toggle_mode_on,
1733                                     state=self.state,
1734                                     enable2D=is_2d,
1735                                     update_chisqr=update_chisqr,
1736                                     source='model',
1737                                     weight=weight)
1738
1739    def _on_show_sld(self, event=None):
1740        """
1741        Plot SLD profile
1742        """
1743        # get profile data
1744        x, y = self.model.getProfile()
1745
1746        from sas.sasgui.plottools import Data1D as pf_data1d
1747        # from sas.sasgui.perspectives.theory.profile_dialog import SLDPanel
1748        from sas.sasgui.guiframe.local_perspectives.plotting.profile_dialog \
1749            import SLDPanel
1750        sld_data = pf_data1d(x, y)
1751        sld_data.name = 'SLD'
1752        sld_data.axes = self.sld_axes
1753        self.panel = SLDPanel(self, data=sld_data, axes=self.sld_axes,
1754                              id=wx.ID_ANY)
1755        self.panel.ShowModal()
1756
1757    def _set_multfactor_combobox(self, multiplicity=10):
1758        """
1759        Set comboBox for muitfactor of CoreMultiShellModel
1760        :param multiplicit: no. of multi-functionality
1761        """
1762        # build content of the combobox
1763        for idx in range(0, multiplicity):
1764            self.multifactorbox.Append(str(idx), int(idx))
1765        self._hide_multfactor_combobox()
1766
1767    def _show_multfactor_combobox(self):
1768        """
1769        Show the comboBox of muitfactor of CoreMultiShellModel
1770        """
1771        if not self.mutifactor_text.IsShown():
1772            self.mutifactor_text.Show(True)
1773            self.mutifactor_text1.Show(True)
1774        if not self.multifactorbox.IsShown():
1775            self.multifactorbox.Show(True)
1776
1777    def _hide_multfactor_combobox(self):
1778        """
1779        Hide the comboBox of muitfactor of CoreMultiShellModel
1780        """
1781        if self.mutifactor_text.IsShown():
1782            self.mutifactor_text.Hide()
1783            self.mutifactor_text1.Hide()
1784        if self.multifactorbox.IsShown():
1785            self.multifactorbox.Hide()
1786
1787    def formfactor_combo_init(self):
1788        """
1789        First time calls _show_combox_helper
1790        """
1791        self._show_combox(None)
1792
1793    def _show_combox_helper(self):
1794        """
1795        Fill panel's combo box according to the type of model selected
1796        """
1797        custom_model = 'Customized Models'
1798        mod_cat = self.categorybox.GetStringSelection()
1799        self.structurebox.SetSelection(0)
1800        self.structurebox.Disable()
1801        self.formfactorbox.Clear()
1802        if mod_cat is None:
1803            return
1804        m_list = []
1805        try:
1806            if mod_cat == custom_model:
1807                for model in self.model_list_box[mod_cat]:
1808                    m_list.append(self.model_dict[model.name])
1809            else:
1810                cat_dic = self.master_category_dict[mod_cat]
1811                for (model, enabled) in cat_dic:
1812                    if enabled:
1813                        m_list.append(self.model_dict[model])
1814        except Exception:
1815            msg = traceback.format_exc()
1816            wx.PostEvent(self._manager.parent,
1817                         StatusEvent(status=msg, info="error"))
1818        self._populate_box(self.formfactorbox, m_list)
1819
1820    def _on_modify_cat(self, event=None):
1821        """
1822        Called when category manager is opened
1823        """
1824        self._manager.parent.on_category_panel(event)
1825
1826    def _show_combox(self, event=None):
1827        """
1828        Show combox box associate with type of model selected
1829        """
1830        self.Show(False)
1831        self._show_combox_helper()
1832        self._on_select_model(event=None)
1833        self.Show(True)
1834        self._save_typeOfmodel()
1835        self.sizer4_4.Layout()
1836        self.sizer4.Layout()
1837        self.Layout()
1838        self.Refresh()
1839
1840    def _populate_box(self, combobox, list):
1841        """
1842        fill combox box with dict item
1843
1844        :param list: contains item to fill the combox
1845            item must model class
1846        """
1847        mlist = []
1848        for models in list:
1849            if models.name != "NoStructure":
1850                mlist.append((models.name, models))
1851
1852        # Sort the models
1853        mlist_sorted = sorted(mlist)
1854        for item in mlist_sorted:
1855            combobox.Append(item[0], item[1])
1856        return 0
1857
1858    def _onQrangeEnter(self, event):
1859        """
1860        Check validity of value enter in the Q range field
1861
1862        """
1863        tcrtl = event.GetEventObject()
1864        # Clear msg if previously shown.
1865        msg = ""
1866        wx.PostEvent(self.parent, StatusEvent(status=msg))
1867        # Flag to register when a parameter has changed.
1868        if tcrtl.GetValue().lstrip().rstrip() != "":
1869            try:
1870                float(tcrtl.GetValue())
1871                tcrtl.SetBackgroundColour(wx.WHITE)
1872                # If qmin and qmax have been modified, update qmin and qmax
1873                if self._validate_qrange(self.qmin, self.qmax):
1874                    tempmin = float(self.qmin.GetValue())
1875                    if tempmin != self.qmin_x:
1876                        self.qmin_x = tempmin
1877                    tempmax = float(self.qmax.GetValue())
1878                    if tempmax != self.qmax_x:
1879                        self.qmax_x = tempmax
1880                else:
1881                    tcrtl.SetBackgroundColour("pink")
1882                    msg = "Model Error: wrong value entered: %s" % \
1883                          sys.exc_info()[1]
1884                    wx.PostEvent(self.parent, StatusEvent(status=msg))
1885                    return
1886            except:
1887                tcrtl.SetBackgroundColour("pink")
1888                msg = "Model Error: wrong value entered: %s" % sys.exc_info()[1]
1889                wx.PostEvent(self.parent, StatusEvent(status=msg))
1890                return
1891            # Check if # of points for theory model are valid(>0).
1892            if self.npts is not None:
1893                if check_float(self.npts):
1894                    temp_npts = float(self.npts.GetValue())
1895                    if temp_npts != self.num_points:
1896                        self.num_points = temp_npts
1897                else:
1898                    msg = "Cannot plot: No points in Q range!!!  "
1899                    wx.PostEvent(self.parent, StatusEvent(status=msg))
1900        else:
1901            tcrtl.SetBackgroundColour("pink")
1902            msg = "Model Error: wrong value entered!!!"
1903            wx.PostEvent(self.parent, StatusEvent(status=msg))
1904        self.save_current_state()
1905        event = PageInfoEvent(page=self)
1906        wx.PostEvent(self.parent, event)
1907        self.state_change = False
1908        # Draw the model for a different range
1909        if not self.data.is_data:
1910            self.create_default_data()
1911        self._draw_model()
1912
1913    def _theory_qrange_enter(self, event):
1914        """
1915        Check validity of value enter in the Q range field
1916        """
1917
1918        tcrtl = event.GetEventObject()
1919        # Clear msg if previously shown.
1920        msg = ""
1921        wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1922        # Flag to register when a parameter has changed.
1923        is_modified = False
1924        if tcrtl.GetValue().lstrip().rstrip() != "":
1925            try:
1926                value = float(tcrtl.GetValue())
1927                tcrtl.SetBackgroundColour(wx.WHITE)
1928
1929                # If qmin and qmax have been modified, update qmin and qmax
1930                if self._validate_qrange(self.theory_qmin, self.theory_qmax):
1931                    tempmin = float(self.theory_qmin.GetValue())
1932                    if tempmin != self.theory_qmin_x:
1933                        self.theory_qmin_x = tempmin
1934                    tempmax = float(self.theory_qmax.GetValue())
1935                    if tempmax != self.qmax_x:
1936                        self.theory_qmax_x = tempmax
1937                else:
1938                    tcrtl.SetBackgroundColour("pink")
1939                    msg = "Model Error: wrong value entered: %s" % \
1940                          sys.exc_info()[1]
1941                    wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1942                    return
1943            except:
1944                tcrtl.SetBackgroundColour("pink")
1945                msg = "Model Error: wrong value entered: %s" % sys.exc_info()[1]
1946                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1947                return
1948            # Check if # of points for theory model are valid(>0).
1949            if self.Npts_total.IsEditable():
1950                if check_float(self.Npts_total):
1951                    temp_npts = float(self.Npts_total.GetValue())
1952                    if temp_npts != self.num_points:
1953                        self.num_points = temp_npts
1954                        is_modified = True
1955                else:
1956                    msg = "Cannot Plot: No points in Q range!!!  "
1957                    wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1958        else:
1959            tcrtl.SetBackgroundColour("pink")
1960            msg = "Model Error: wrong value entered!!!"
1961            wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
1962        self.save_current_state()
1963        event = PageInfoEvent(page=self)
1964        wx.PostEvent(self.parent, event)
1965        self.state_change = False
1966        # Draw the model for a different range
1967        self.create_default_data()
1968        self._draw_model()
1969
1970    def _on_select_model_helper(self):
1971        """
1972        call back for model selection
1973        """
1974        # reset dictionary containing reference to dispersion
1975        self._disp_obj_dict = {}
1976        self.disp_cb_dict = {}
1977        self.temp_multi_functional = False
1978        f_id = self.formfactorbox.GetCurrentSelection()
1979        # For MAC
1980        form_factor = None
1981        if f_id >= 0:
1982            form_factor = self.formfactorbox.GetClientData(f_id)
1983
1984        if form_factor is None or \
1985            not hasattr(form_factor, 'is_form_factor') or \
1986                not form_factor.is_form_factor:
1987            self.structurebox.Hide()
1988            self.text2.Hide()
1989            self.structurebox.Disable()
1990            self.structurebox.SetSelection(0)
1991            self.text2.Disable()
1992        else:
1993            self.structurebox.Show()
1994            self.text2.Show()
1995            self.structurebox.Enable()
1996            self.text2.Enable()
1997
1998        if form_factor is not None:
1999            # set multifactor for Mutifunctional models
2000            if form_factor.is_multiplicity_model:
2001                m_id = self.multifactorbox.GetCurrentSelection()
2002                multiplicity = form_factor.multiplicity_info[0]
2003                self.multifactorbox.Clear()
2004                self._set_multfactor_combobox(multiplicity)
2005                self._show_multfactor_combobox()
2006                # ToDo: this info should be called directly from the model
2007                text = form_factor.multiplicity_info[1]  # 'No. of Shells: '
2008
2009                self.mutifactor_text.SetLabel(text)
2010                if m_id > multiplicity - 1:
2011                    # default value
2012                    m_id = 1
2013
2014                self.multi_factor = self.multifactorbox.GetClientData(m_id)
2015                if self.multi_factor is None:
2016                    self.multi_factor = 0
2017                self.multifactorbox.SetSelection(m_id)
2018                # Check len of the text1 and max_multiplicity
2019                text = ''
2020                if form_factor.multiplicity_info[0] == \
2021                        len(form_factor.multiplicity_info[2]):
2022                    text = form_factor.multiplicity_info[2][self.multi_factor]
2023                self.mutifactor_text1.SetLabel(text)
2024                # Check if model has  get sld profile.
2025                if len(form_factor.multiplicity_info[3]) > 0:
2026                    self.sld_axes = form_factor.multiplicity_info[3]
2027                    self.show_sld_button.Show(True)
2028                else:
2029                    self.sld_axes = ""
2030            else:
2031                self._hide_multfactor_combobox()
2032                self.show_sld_button.Hide()
2033                self.multi_factor = None
2034        else:
2035            self._hide_multfactor_combobox()
2036            self.show_sld_button.Hide()
2037            self.multi_factor = None
2038
2039        s_id = self.structurebox.GetCurrentSelection()
2040        struct_factor = self.structurebox.GetClientData(s_id)
2041
2042        if struct_factor is not None:
2043            from sasmodels.sasview_model import MultiplicationModel
2044            self.model = MultiplicationModel(form_factor(self.multi_factor),
2045                                             struct_factor())
2046            # multifunctional form factor
2047            if len(form_factor.non_fittable) > 0:
2048                self.temp_multi_functional = True
2049        elif form_factor is not None:
2050            if self.multi_factor is not None:
2051                self.model = form_factor(self.multi_factor)
2052            else:
2053                # old style plugin models do not accept a multiplicity argument
2054                self.model = form_factor()
2055        else:
2056            self.model = None
2057            return
2058
2059        # check if model has magnetic parameters
2060        if len(self.model.magnetic_params) > 0:
2061            self._has_magnetic = True
2062        else:
2063            self._has_magnetic = False
2064        # post state to fit panel
2065        self.state.parameters = []
2066        self.state.model = self.model
2067        self.state.qmin = self.qmin_x
2068        self.state.multi_factor = self.multi_factor
2069        self.disp_list = self.model.getDispParamList()
2070        self.state.disp_list = self.disp_list
2071        self.on_set_focus(None)
2072        self.Layout()
2073
2074    def _validate_qrange(self, qmin_ctrl, qmax_ctrl):
2075        """
2076        Verify that the Q range controls have valid values
2077        and that Qmin < Qmax.
2078
2079        :param qmin_ctrl: text control for Qmin
2080        :param qmax_ctrl: text control for Qmax
2081
2082        :return: True is the Q range is value, False otherwise
2083
2084        """
2085        qmin_validity = check_float(qmin_ctrl)
2086        qmax_validity = check_float(qmax_ctrl)
2087        if not (qmin_validity and qmax_validity):
2088            return False
2089        else:
2090            qmin = float(qmin_ctrl.GetValue())
2091            qmax = float(qmax_ctrl.GetValue())
2092            if qmin < qmax:
2093                # Make sure to set both colours white.
2094                qmin_ctrl.SetBackgroundColour(wx.WHITE)
2095                qmin_ctrl.Refresh()
2096                qmax_ctrl.SetBackgroundColour(wx.WHITE)
2097                qmax_ctrl.Refresh()
2098            else:
2099                qmin_ctrl.SetBackgroundColour("pink")
2100                qmin_ctrl.Refresh()
2101                qmax_ctrl.SetBackgroundColour("pink")
2102                qmax_ctrl.Refresh()
2103                msg = "Invalid Q range: Q min must be smaller than Q max"
2104                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
2105                return False
2106        return True
2107
2108    def _validate_Npts(self):
2109        """
2110        Validate the number of points for fitting is more than 10 points.
2111        If valid, setvalues Npts_fit otherwise post msg.
2112        """
2113        # default flag
2114        flag = True
2115        # Theory
2116        if self.data is None and self.enable2D:
2117            return flag
2118        for data in self.data_list:
2119            # q value from qx and qy
2120            radius = numpy.sqrt(data.qx_data * data.qx_data +
2121                                data.qy_data * data.qy_data)
2122            # get unmasked index
2123            index_data = (float(self.qmin.GetValue()) <= radius) & \
2124                         (radius <= float(self.qmax.GetValue()))
2125            index_data = (index_data) & (data.mask)
2126            index_data = (index_data) & (numpy.isfinite(data.data))
2127
2128            if len(index_data[index_data]) < 10:
2129                # change the color pink.
2130                self.qmin.SetBackgroundColour("pink")
2131                self.qmin.Refresh()
2132                self.qmax.SetBackgroundColour("pink")
2133                self.qmax.Refresh()
2134                msg = "Data Error: "
2135                msg += "Too few points in %s." % data.name
2136                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
2137                self.fitrange = False
2138                flag = False
2139            else:
2140                self.Npts_fit.SetValue(str(len(index_data[index_data is True])))
2141                self.fitrange = True
2142
2143        return flag
2144
2145    def _validate_Npts_1D(self):
2146        """
2147        Validate the number of points for fitting is more than 5 points.
2148        If valid, setvalues Npts_fit otherwise post msg.
2149        """
2150        # default flag
2151        flag = True
2152        # Theory
2153        if self.data is None:
2154            return flag
2155        for data in self.data_list:
2156            # q value from qx and qy
2157            radius = data.x
2158            # get unmasked index
2159            index_data = (float(self.qmin.GetValue()) <= radius) & \
2160                         (radius <= float(self.qmax.GetValue()))
2161            index_data = (index_data) & (numpy.isfinite(data.y))
2162
2163            if len(index_data[index_data]) < 5:
2164                # change the color pink.
2165                self.qmin.SetBackgroundColour("pink")
2166                self.qmin.Refresh()
2167                self.qmax.SetBackgroundColour("pink")
2168                self.qmax.Refresh()
2169                msg = "Data Error: "
2170                msg += "Too few points in %s." % data.name
2171                wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
2172                self.fitrange = False
2173                flag = False
2174            else:
2175                self.Npts_fit.SetValue(str(len(index_data[index_data is True])))
2176                self.fitrange = True
2177
2178        return flag
2179
2180    def _check_value_enter(self, list):
2181        """
2182        :param list: model parameter and panel info
2183        :Note: each item of the list should be as follow:
2184            item=[check button state, parameter's name,
2185                paramater's value, string="+/-",
2186                parameter's error of fit,
2187                parameter's minimum value,
2188                parameter's maximum value ,
2189                parameter's units]
2190
2191        Returns True if the model parameters have changed.
2192        """
2193        is_modified = False
2194        for item in list:
2195            # skip angle parameters for 1D
2196            if not self.enable2D and item in self.orientation_params:
2197                continue
2198
2199            value_ctrl = item[2]
2200            if not value_ctrl.IsEnabled():
2201                # ArrayDispersion disables PD, Min, Max, Npts, Nsigs
2202                continue
2203
2204            name = item[1]
2205            value_str = value_ctrl.GetValue().strip()
2206            if name.endswith(".npts"):
2207                validity = check_int(value_ctrl)
2208                if not validity:
2209                    continue
2210                value = int(value_str)
2211
2212            elif name.endswith(".nsigmas"):
2213                validity = check_float(value_ctrl)
2214                if not validity:
2215                    continue
2216                value = float(value_str)
2217
2218            else:  # value or polydispersity
2219
2220                # Check that min, max and value are floats
2221                min_ctrl, max_ctrl = item[5], item[6]
2222                min_str = min_ctrl.GetValue().strip()
2223                max_str = max_ctrl.GetValue().strip()
2224                validity = check_float(value_ctrl)
2225                if min_str != "":
2226                    validity = validity and check_float(min_ctrl)
2227                if max_str != "":
2228                    validity = validity and check_float(max_ctrl)
2229                if not validity:
2230                    continue
2231
2232                # Check that min is less than max
2233                low = -numpy.inf if min_str == "" else float(min_str)
2234                high = numpy.inf if max_str == "" else float(max_str)
2235                if high < low:
2236                    min_ctrl.SetBackgroundColour("pink")
2237                    min_ctrl.Refresh()
2238                    max_ctrl.SetBackgroundColour("pink")
2239                    max_ctrl.Refresh()
2240                    # msg = "Invalid fit range for %s: min must be smaller
2241                    # than max"%name
2242                    # wx.PostEvent(self._manager.parent,
2243                    # StatusEvent(status=msg))
2244                    continue
2245
2246                # Force value between min and max
2247                value = float(value_str)
2248                if value < low:
2249                    value = low
2250                    value_ctrl.SetValue(format_number(value))
2251                elif value > high:
2252                    value = high
2253                    value_ctrl.SetValue(format_number(value))
2254
2255                if name not in self.model.details.keys():
2256                    self.model.details[name] = ["", None, None]
2257                old_low, old_high = self.model.details[name][1:3]
2258                if old_low != low or old_high != high:
2259                    # The configuration has changed but it won't change the
2260                    # computed curve so no need to set is_modified to True
2261                    # is_modified = True
2262                    self.model.details[name][1:3] = low, high
2263
2264            # Update value in model if it has changed
2265            if value != self.model.getParam(name):
2266                self.model.setParam(name, value)
2267                is_modified = True
2268
2269        return is_modified
2270
2271    def _set_dipers_Param(self, event):
2272        """
2273        respond to self.enable_disp and self.disable_disp radio box.
2274        The dispersity object is reset inside the model into Gaussian.
2275        When the user select yes , this method display a combo box for
2276        more selection when the user selects No,the combo box disappears.
2277        Redraw the model with the default dispersity (Gaussian)
2278        """
2279        # On selction if no model exists.
2280        if self.model is None:
2281            self.disable_disp.SetValue(True)
2282            msg = "Please select a Model first..."
2283            wx.MessageBox(msg, 'Info')
2284            wx.PostEvent(self._manager.parent,
2285                         StatusEvent(status="Polydispersion: %s" % msg))
2286            return
2287
2288        self._reset_dispersity()
2289
2290        if self.model is None:
2291            self.model_disp.Hide()
2292            self.sizer4_4.Clear(True)
2293            return
2294
2295        if self.enable_disp.GetValue():
2296            # layout for model containing no dispersity parameters
2297
2298            self.disp_list = self.model.getDispParamList()
2299
2300            if len(self.disp_list) == 0 and len(self.disp_cb_dict) == 0:
2301                self._layout_sizer_noDipers()
2302            else:
2303                # set gaussian sizer
2304                self._on_select_Disp(event=None)
2305        else:
2306            self.sizer4_4.Clear(True)
2307
2308        # post state to fit panel
2309        self.save_current_state()
2310        if event is not None:
2311            event = PageInfoEvent(page=self)
2312            wx.PostEvent(self.parent, event)
2313        # draw the model with the current dispersity
2314
2315        # Wojtek P, Oct 8, 2016: Calling draw_model seems to be unessecary.
2316        # By comenting it we save an extra Iq calculation
2317        # self._draw_model()
2318
2319        # Need to use FitInside again here to replace the next four lines.
2320        # Otherwised polydispersity off does not resize the scrollwindow.
2321        # PDB Nov 28, 2015
2322        self.FitInside()
2323#        self.sizer4_4.Layout()
2324#        self.sizer5.Layout()
2325#        self.Layout()
2326#        self.Refresh()
2327
2328    def _layout_sizer_noDipers(self):
2329        """
2330        Draw a sizer with no dispersity info
2331        """
2332        ix = 0
2333        iy = 1
2334        self.fittable_param = []
2335        self.fixed_param = []
2336        self.orientation_params_disp = []
2337
2338        self.sizer4_4.Clear(True)
2339        text = "No polydispersity available for this model"
2340        model_disp = wx.StaticText(self, wx.ID_ANY, text)
2341        self.sizer4_4.Add(model_disp, (iy, ix), (1, 1),
2342                          wx.LEFT | wx.EXPAND | wx.ADJUST_MINSIZE, 10)
2343        self.sizer4_4.Layout()
2344        self.sizer4.Layout()
2345
2346    def _reset_dispersity(self):
2347        """
2348        put gaussian dispersity into current model
2349        """
2350        if len(self.param_toFit) > 0:
2351            for item in self.fittable_param:
2352                if item in self.param_toFit:
2353                    self.param_toFit.remove(item)
2354
2355            for item in self.orientation_params_disp:
2356                if item in self.param_toFit:
2357                    self.param_toFit.remove(item)
2358
2359        self.fittable_param = []
2360        self.fixed_param = []
2361        self.orientation_params_disp = []
2362        self.values = {}
2363        self.weights = {}
2364
2365        # from sas.models.dispersion_models import GaussianDispersion
2366        from sasmodels.weights import GaussianDispersion
2367        if len(self.disp_cb_dict) == 0:
2368            self.save_current_state()
2369            self.sizer4_4.Clear(True)
2370            self.Layout()
2371            return
2372        if (len(self.disp_cb_dict) > 0):
2373            for p in self.disp_cb_dict:
2374                # The parameter was un-selected.
2375                # Go back to Gaussian model (with 0 pts)
2376                disp_model = GaussianDispersion()
2377
2378                self._disp_obj_dict[p] = disp_model
2379                # Set the new model as the dispersion object
2380                # for the selected parameter
2381                try:
2382                    self.model.set_dispersion(p, disp_model)
2383                except Exception:
2384                    logging.error(traceback.format_exc())
2385
2386        # save state into
2387        self.save_current_state()
2388        self.Layout()
2389        self.Refresh()
2390
2391    def _on_select_Disp(self, event):
2392        """
2393        allow selecting different dispersion
2394        self.disp_list should change type later .now only gaussian
2395        """
2396        self._set_sizer_dispersion()
2397
2398        # Redraw the model
2399        self._draw_model()
2400        # self._undo.Enable(True)
2401        event = PageInfoEvent(page=self)
2402        wx.PostEvent(self.parent, event)
2403
2404        self.sizer4_4.Layout()
2405        self.sizer4.Layout()
2406        self.SetupScrolling()
2407
2408    def _on_disp_func(self, event=None):
2409        """
2410        Select a distribution function for the polydispersion
2411
2412        :Param event: ComboBox event
2413        """
2414        # get ready for new event
2415        if event is not None:
2416            event.Skip()
2417        # Get event object
2418        disp_box = event.GetEventObject()
2419
2420        # Try to select a Distr. function
2421        try:
2422            disp_box.SetBackgroundColour("white")
2423            selection = disp_box.GetCurrentSelection()
2424            param_name = disp_box.Name.split('.')[0]
2425            disp_name = disp_box.GetValue()
2426            dispersity = disp_box.GetClientData(selection)
2427
2428            # disp_model =  GaussianDispersion()
2429            disp_model = dispersity()
2430            # Get param names to reset the values of the param
2431            name1 = param_name + ".width"
2432            name2 = param_name + ".npts"
2433            name3 = param_name + ".nsigmas"
2434            # Check Disp. function whether or not it is 'array'
2435            if disp_name.lower() == "array":
2436                value2 = ""
2437                value3 = ""
2438                value1 = self._set_array_disp(name=name1, disp=disp_model)
2439            else:
2440                self._del_array_values(name1)
2441                # self._reset_array_disp(param_name)
2442                self._disp_obj_dict[name1] = disp_model
2443                self.model.set_dispersion(param_name, disp_model)
2444                self.state._disp_obj_dict[name1] = disp_model.type
2445
2446                value1 = str(format_number(self.model.getParam(name1), True))
2447                value2 = str(format_number(self.model.getParam(name2)))
2448                value3 = str(format_number(self.model.getParam(name3)))
2449            # Reset fittable polydispersin parameter value
2450            for item in self.fittable_param:
2451                if item[1] == name1:
2452                    item[2].SetValue(value1)
2453                    item[5].SetValue("")
2454                    item[6].SetValue("")
2455                    # Disable for array
2456                    if disp_name.lower() == "array":
2457                        item[0].SetValue(False)
2458                        item[0].Disable()
2459                        item[2].Disable()
2460                        item[3].Show(False)
2461                        item[4].Show(False)
2462                        item[5].Disable()
2463                        item[6].Disable()
2464                    else:
2465                        item[0].Enable()
2466                        item[2].Enable()
2467                        item[3].Show(True)
2468                        item[4].Show(True)
2469                        item[5].Enable()
2470                        item[6].Enable()
2471                    break
2472            # Reset fixed polydispersion params
2473            for item in self.fixed_param:
2474                if item[1] == name2:
2475                    item[2].SetValue(value2)
2476                    # Disable Npts for array
2477                    if disp_name.lower() == "array":
2478                        item[2].Disable()
2479                    else:
2480                        item[2].Enable()
2481                if item[1] == name3:
2482                    item[2].SetValue(value3)
2483                    # Disable Nsigs for array
2484                    if disp_name.lower() == "array":
2485                        item[2].Disable()
2486                    else:
2487                        item[2].Enable()
2488
2489            # Make sure the check box updated
2490            self.get_all_checked_params()
2491
2492            # update params
2493            self._update_paramv_on_fit()
2494            # draw
2495            self._draw_model()
2496            self.Refresh()
2497        except Exception:
2498            logging.error(traceback.format_exc())
2499            # Error msg
2500            msg = "Error occurred:"
2501            msg += " Could not select the distribution function..."
2502            msg += " Please select another distribution function."
2503            disp_box.SetBackgroundColour("pink")
2504            # Focus on Fit button so that users can see the pinky box
2505            self.btFit.SetFocus()
2506            wx.PostEvent(self._manager.parent,
2507                         StatusEvent(status=msg, info="error"))
2508
2509    def _set_array_disp(self, name=None, disp=None):
2510        """
2511        Set array dispersion
2512
2513        :param name: name of the parameter for the dispersion to be set
2514        :param disp: the polydisperion object
2515        """
2516        # The user wants this parameter to be averaged.
2517        # Pop up the file selection dialog.
2518        path = self._selectDlg()
2519        # Array data
2520        values = []
2521        weights = []
2522        # If nothing was selected, just return
2523        if path is None:
2524            self.disp_cb_dict[name].SetValue(False)
2525            # self.noDisper_rbox.SetValue(True)
2526            return
2527        self._default_save_location = os.path.dirname(path)
2528        if self._manager is not None:
2529            self._manager.parent._default_save_location = \
2530                             self._default_save_location
2531
2532        basename = os.path.basename(path)
2533        values, weights = self.read_file(path)
2534
2535        # If any of the two arrays is empty, notify the user that we won't
2536        # proceed
2537        if len(self.param_toFit) > 0:
2538            if name in self.param_toFit:
2539                self.param_toFit.remove(name)
2540
2541        # Tell the user that we are about to apply the distribution
2542        msg = "Applying loaded %s distribution: %s" % (name, path)
2543        wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
2544        self._set_array_disp_model(name=name, disp=disp,
2545                                   values=values, weights=weights)
2546        return basename
2547
2548    def _set_array_disp_model(self, name=None, disp=None,
2549                              values=[], weights=[]):
2550        """
2551        Set array dispersion model
2552
2553        :param name: name of the parameter for the dispersion to be set
2554        :param disp: the polydisperion object
2555        """
2556        disp.set_weights(values, weights)
2557        self._disp_obj_dict[name] = disp
2558        self.model.set_dispersion(name.split('.')[0], disp)
2559        self.state._disp_obj_dict[name] = disp.type
2560        self.values[name] = values
2561        self.weights[name] = weights
2562        # Store the object to make it persist outside the
2563        # scope of this method
2564        # TODO: refactor model to clean this up?
2565        self.state.values = {}
2566        self.state.weights = {}
2567        self.state.values = copy.deepcopy(self.values)
2568        self.state.weights = copy.deepcopy(self.weights)
2569
2570        # Set the new model as the dispersion object for the
2571        # selected parameter
2572        # self.model.set_dispersion(p, disp_model)
2573        # Store a reference to the weights in the model object
2574        # so that
2575        # it's not lost when we use the model within another thread.
2576        self.state.model = self.model.clone()
2577        self.model._persistency_dict[name.split('.')[0]] = \
2578            [values, weights]
2579        self.state.model._persistency_dict[name.split('.')[0]] = \
2580            [values, weights]
2581
2582    def _del_array_values(self, name=None):
2583        """
2584        Reset array dispersion
2585
2586        :param name: name of the parameter for the dispersion to be set
2587        """
2588        # Try to delete values and weight of the names array dic if exists
2589        try:
2590            if name in self.values:
2591                del self.values[name]
2592                del self.weights[name]
2593                # delete all other dic
2594                del self.state.values[name]
2595                del self.state.weights[name]
2596                del self.model._persistency_dict[name.split('.')[0]]
2597                del self.state.model._persistency_dict[name.split('.')[0]]
2598        except Exception:
2599            logging.error(traceback.format_exc())
2600
2601    def _lay_out(self):
2602        """
2603        returns self.Layout
2604
2605        :Note: Mac seems to like this better when self.
2606            Layout is called after fitting.
2607        """
2608        self._sleep4sec()
2609        self.Layout()
2610        return
2611
2612    def _sleep4sec(self):
2613        """
2614            sleep for 1 sec only applied on Mac
2615            Note: This 1sec helps for Mac not to crash on self.
2616            Layout after self._draw_model
2617        """
2618        if ON_MAC is True:
2619            time.sleep(1)
2620
2621    def _find_polyfunc_selection(self, disp_func=None):
2622        """
2623        FInd Comboox selection from disp_func
2624
2625        :param disp_function: dispersion distr. function
2626        """
2627        # Find the selection
2628        if disp_func is not None:
2629            try:
2630                return POLYDISPERSITY_MODELS.values().index(disp_func.__class__)
2631            except ValueError:
2632                pass  # Fall through to default class
2633        return POLYDISPERSITY_MODELS.keys().index('gaussian')
2634
2635    def on_reset_clicked(self, event):
2636        """
2637        On 'Reset' button  for Q range clicked
2638        """
2639        flag = True
2640        # For 3 different cases: Data2D, Data1D, and theory
2641        if self.model is None:
2642            msg = "Please select a model first..."
2643            wx.MessageBox(msg, 'Info')
2644            flag = False
2645            return
2646
2647        elif self.data.__class__.__name__ == "Data2D":
2648            data_min = 0
2649            x = max(math.fabs(self.data.xmin), math.fabs(self.data.xmax))
2650            y = max(math.fabs(self.data.ymin), math.fabs(self.data.ymax))
2651            self.qmin_x = data_min
2652            self.qmax_x = math.sqrt(x * x + y * y)
2653            # self.data.mask = numpy.ones(len(self.data.data),dtype=bool)
2654            # check smearing
2655            if not self.disable_smearer.GetValue():
2656                # set smearing value whether or
2657                # not the data contain the smearing info
2658                if self.pinhole_smearer.GetValue():
2659                    flag = self.update_pinhole_smear()
2660                else:
2661                    flag = True
2662
2663        elif self.data is None:
2664            self.qmin_x = _QMIN_DEFAULT
2665            self.qmax_x = _QMAX_DEFAULT
2666            self.num_points = _NPTS_DEFAULT
2667            self.state.npts = self.num_points
2668
2669        elif self.data.__class__.__name__ != "Data2D":
2670            self.qmin_x = min(self.data.x)
2671            self.qmax_x = max(self.data.x)
2672            # check smearing
2673            if not self.disable_smearer.GetValue():
2674                # set smearing value whether or
2675                # not the data contain the smearing info
2676                if self.slit_smearer.GetValue():
2677                    flag = self.update_slit_smear()
2678                elif self.pinhole_smearer.GetValue():
2679                    flag = self.update_pinhole_smear()
2680                else:
2681                    flag = True
2682        else:
2683            flag = False
2684
2685        if flag is False:
2686            msg = "Cannot Plot :Must enter a number!!!  "
2687            wx.PostEvent(self._manager.parent, StatusEvent(status=msg))
2688        else:
2689            # set relative text ctrs.
2690            self.qmin.SetValue(str(self.qmin_x))
2691            self.qmax.SetValue(str(self.qmax_x))
2692            self.show_npts2fit()
2693            # At this point, some button and variables satatus (disabled?)
2694            # should be checked such as color that should be reset to
2695            # white in case that it was pink.
2696            self._onparamEnter_helper()
2697
2698        self.save_current_state()
2699        self.state.qmin = self.qmin_x
2700        self.state.qmax = self.qmax_x
2701
2702        # reset the q range values
2703        self._reset_plotting_range(self.state)
2704        self._draw_model()
2705
2706    def select_log(self, event):
2707        """
2708        Log checked to generate log spaced points for theory model
2709        """
2710
2711    def get_images(self):
2712        """
2713        Get the images of the plots corresponding this panel for report
2714
2715        : return graphs: list of figures
2716        : Need Move to guiframe
2717        """
2718        # set list of graphs
2719        graphs = []
2720        canvases = []
2721        res_item = None
2722        # call gui_manager
2723        gui_manager = self._manager.parent
2724        # loops through the panels [dic]
2725        for _, item2 in gui_manager.plot_panels.iteritems():
2726            data_title = self.data.group_id
2727            # try to get all plots belonging to this control panel
2728            try:
2729                g_id = item2.group_id
2730                if g_id == data_title or \
2731                        str(g_id).count("res" + str(self.graph_id)) or \
2732                        str(g_id).count(str(self.uid)) > 0:
2733                    if str(g_id).count("res" + str(self.graph_id)) > 0:
2734                        res_item = [item2.figure, item2.canvas]
2735                    else:
2736                        # append to the list
2737                        graphs.append(item2.figure)
2738                        canvases.append(item2.canvas)
2739            except Exception:
2740                # Not for control panels
2741                logging.error(traceback.format_exc())
2742        # Make sure the resduals plot goes to the last
2743        if res_item is not None:
2744            graphs.append(res_item[0])
2745            canvases.append(res_item[1])
2746        # return the list of graphs
2747        return graphs, canvases
2748
2749    def on_function_help_clicked(self, event):
2750        """
2751        Function called when 'Help' button is pressed next to model
2752        of interest.  This calls DocumentationWindow from
2753        documentation_window.py. It will load the top level of the model
2754        help documenation sphinx generated html if no model is presented.
2755        If a model IS present then if documention for that model exists
2756        it will load to that  point otherwise again it will go to the top.
2757        For Wx2.8 and below is used (i.e. non-released through installer)
2758        a browser is loaded and the top of the model documentation only is
2759        accessible because webbrowser module does not pass anything after
2760        the # to the browser.
2761
2762        :param event: on Help Button pressed event
2763        """
2764
2765        if self.model is not None:
2766            name = self.formfactorbox.GetValue()
2767            _TreeLocation = 'user/models/' + name.lower()+'.html'
2768            _doc_viewer = DocumentationWindow(self, wx.ID_ANY, _TreeLocation,
2769                                              "", name + " Help")
2770        else:
2771            _TreeLocation = 'user/index.html'
2772            _doc_viewer = DocumentationWindow(self, wx.ID_ANY, _TreeLocation,
2773                                              "", "General Model Help")
2774
2775    def on_model_help_clicked(self, event):
2776        """
2777        Function called when 'Description' button is pressed next to model
2778        of interest.  This calls the Description embedded in the model. This
2779        should work with either Wx2.8 and lower or higher. If no model is
2780        selected it will give the message that a model must be chosen first
2781        in the box that would normally contain the description.  If a badly
2782        behaved model is encountered which has no description then it will
2783        give the message that none is available.
2784
2785        :param event: on Description Button pressed event
2786        """
2787
2788        if self.model is None:
2789            name = 'index.html'
2790        else:
2791            name = self.formfactorbox.GetValue()
2792
2793        msg = 'Model description:\n'
2794        info = "Info"
2795        if self.model is not None:
2796            # frame.Destroy()
2797            if str(self.model.description).rstrip().lstrip() == '':
2798                msg += "Sorry, no information is available for this model."
2799            else:
2800                msg += self.model.description + '\n'
2801            wx.MessageBox(msg, info)
2802        else:
2803            msg += "You must select a model to get information on this"
2804            wx.MessageBox(msg, info)
2805
2806    def _on_mag_angle_help(self, event):
2807        """
2808        Bring up Magnetic Angle definition bmp image whenever the ? button
2809        is clicked. Calls DocumentationWindow with the path of the location
2810        within the documentation tree (after /doc/ ....". When using old
2811        versions of Wx (i.e. before 2.9 and therefore not part of release
2812        versions distributed via installer) it brings up an image viewer
2813        box which allows the user to click through the rest of the images in
2814        the directory.  Not ideal but probably better than alternative which
2815        would bring up the entire discussion of how magnetic models work?
2816        Specially since it is not likely to be accessed.  The normal release
2817        versions bring up the normal image box.
2818
2819        :param evt: Triggers on clicking ? in Magnetic Angles? box
2820        """
2821
2822        _TreeLocation = "_images/M_angles_pic.bmp"
2823        _doc_viewer = DocumentationWindow(self, wx.ID_ANY, _TreeLocation, "",
2824                                          "Magnetic Angle Defintions")
2825
2826    def _on_mag_help(self, event):
2827        """
2828        Bring up Magnetic Angle definition bmp image whenever the ? button
2829        is clicked. Calls DocumentationWindow with the path of the location
2830        within the documentation tree (after /doc/ ....". When using old
2831        versions of Wx (i.e. before 2.9 and therefore not part of release
2832        versions distributed via installer) it brings up an image viewer
2833        box which allows the user to click through the rest of the images in
2834        the directory.  Not ideal but probably better than alternative which
2835        would bring up the entire discussion of how magnetic models work?
2836        Specially since it is not likely to be accessed.  The normal release
2837        versions bring up the normal image box.
2838
2839        :param evt: Triggers on clicking ? in Magnetic Angles? box
2840        """
2841
2842        _TreeLocation = "user/magnetism.html"
2843        _doc_viewer = DocumentationWindow(self, wx.ID_ANY, _TreeLocation, "",
2844                                          "Polarized Beam/Magnetc Help")
2845
2846    def _on_mag_on(self, event):
2847        """
2848        Magnetic Parameters ON/OFF
2849        """
2850        button = event.GetEventObject()
2851
2852        if button.GetLabel().count('ON') > 0:
2853            self.magnetic_on = True
2854            button.SetLabel("Magnetic OFF")
2855            m_value = 1.0e-06
2856            for key in self.model.magnetic_params:
2857                if key.count('M0') > 0:
2858                    self.model.setParam(key, m_value)
2859                    m_value += 0.5e-06
2860        else:
2861            self.magnetic_on = False
2862            button.SetLabel("Magnetic ON")
2863            for key in self.model.magnetic_params:
2864                if key.count('M0') > 0:
2865                    # reset mag value to zero fo safety
2866                    self.model.setParam(key, 0.0)
2867
2868        self.Show(False)
2869        self.set_model_param_sizer(self.model)
2870        # self._set_sizer_dispersion()
2871        self.state.magnetic_on = self.magnetic_on
2872        self.SetupScrolling()
2873        self.Show(True)
2874
2875    def on_pd_help_clicked(self, event):
2876        """
2877        Bring up Polydispersity Documentation whenever the ? button is clicked.
2878        Calls DocumentationWindow with the path of the location within the
2879        documentation tree (after /doc/ ....".  Note that when using old
2880        versions of Wx (before 2.9) and thus not the release version of
2881        istallers, the help comes up at the top level of the file as
2882        webbrowser does not pass anything past the # to the browser when it is
2883        running "file:///...."
2884
2885        :param event: Triggers on clicking ? in polydispersity box
2886        """
2887
2888        _TreeLocation = "user/sasgui/perspectives/fitting/pd_help.html"
2889        _PageAnchor = ""
2890        _doc_viewer = DocumentationWindow(self, wx.ID_ANY, _TreeLocation,
2891                                          _PageAnchor, "Polydispersity Help")
2892
2893    def on_left_down(self, event):
2894        """
2895        Get key stroke event
2896        """
2897        # Figuring out key combo: Cmd for copy, Alt for paste
2898        if event.CmdDown() and event.ShiftDown():
2899            self.get_paste()
2900        elif event.CmdDown():
2901            self.get_copy()
2902        else:
2903            event.Skip()
2904            return
2905        # make event free
2906        event.Skip()
2907
2908    def get_copy(self):
2909        """
2910        Get copy params to clipboard
2911        """
2912        content = self.get_copy_params()
2913        flag = self.set_clipboard(content)
2914        self._copy_info(flag)
2915        return flag
2916
2917    def get_copy_params(self):
2918        """
2919        Get the string copies of the param names and values in the tap
2920        """
2921        content = 'sasview_parameter_values:'
2922        # Do it if params exist
2923        if self.parameters:
2924
2925            # go through the parameters
2926            strings = self._get_copy_helper(self.parameters,
2927                                           self.orientation_params)
2928            content += strings
2929
2930            # go through the fittables
2931            strings = self._get_copy_helper(self.fittable_param,
2932                                           self.orientation_params_disp)
2933            content += strings
2934
2935            # go through the fixed params
2936            strings = self._get_copy_helper(self.fixed_param,
2937                                           self.orientation_params_disp)
2938            content += strings
2939
2940            # go through the str params
2941            strings = self._get_copy_helper(self.str_parameters,
2942                                           self.orientation_params)
2943            content += strings
2944            return content
2945        else:
2946            return False
2947
2948    def get_copy_excel(self):
2949        """
2950        Get copy params to clipboard
2951        """
2952        content = self.get_copy_params_excel()
2953        flag = self.set_clipboard(content)
2954        self._copy_info(flag)
2955        return flag
2956
2957    def get_copy_params_excel(self):
2958        """
2959        Get the string copies of the param names and values in the tap
2960        """
2961        content = ''
2962
2963        crlf = chr(13) + chr(10)
2964        tab = chr(9)
2965
2966        # Do it if params exist
2967        if self.parameters:
2968
2969            for param in self.parameters:
2970                content += param[1]  # parameter name
2971                content += tab
2972                content += param[1] + "_err"
2973                content += tab
2974
2975            content += crlf
2976
2977            # row of values and errors...
2978            for param in self.parameters:
2979                content += param[2].GetValue()  # value
2980                content += tab
2981                content += param[4].GetValue()  # error
2982                content += tab
2983
2984            return content
2985        else:
2986            return False
2987
2988    def get_copy_latex(self):
2989        """
2990        Get copy params to clipboard
2991        """
2992        content = self.get_copy_params_latex()
2993        flag = self.set_clipboard(content)
2994        self._copy_info(flag)
2995        return flag
2996
2997    def get_copy_params_latex(self):
2998        """
2999        Get the string copies of the param names and values in the tap
3000        """
3001        content = '\\begin{table}'
3002        content += '\\begin{tabular}[h]'
3003
3004        crlf = chr(13) + chr(10)
3005        tab = chr(9)
3006
3007        # Do it if params exist
3008        if self.parameters:
3009
3010            content += '{|'
3011            for param in self.parameters:
3012                content += 'l|l|'
3013            content += '}\hline'
3014            content += crlf
3015
3016            for index, param in enumerate(self.parameters):
3017                content += param[1].replace('_', '\_')  # parameter name
3018                content += ' & '
3019                content += param[1].replace('_', '\_') + "\_err"
3020                if index < len(self.parameters) - 1:
3021                    content += ' & '
3022            content += '\\\\ \\hline'
3023            content += crlf
3024
3025            # row of values and errors...
3026            for index, param in enumerate(self.parameters):
3027                content += param[2].GetValue()  # parameter value
3028                content += ' & '
3029                content += param[4].GetValue()  # parameter error
3030                if index < len(self.parameters) - 1:
3031                    content += ' & '
3032            content += '\\\\ \\hline'
3033            content += crlf
3034
3035            content += '\\end{tabular}'
3036            content += '\\end{table}'
3037            return content
3038        else:
3039            return False
3040
3041    def set_clipboard(self, content=None):
3042        """
3043        Put the string to the clipboard
3044        """
3045        if not content:
3046            return False
3047        if wx.TheClipboard.Open():
3048            wx.TheClipboard.SetData(wx.TextDataObject(str(content)))
3049            wx.TheClipboard.Close()
3050            return True
3051        return None
3052
3053    def _get_copy_helper(self, param, orient_param):
3054        """
3055        Helping get value and name of the params
3056
3057        : param param:  parameters
3058        : param orient_param = oritational params
3059        : return content: strings [list] [name,value:....]
3060        """
3061        content = ''
3062        bound_hi = ''
3063        bound_lo = ''
3064        # go through the str params
3065        for item in param:
3066            # copy only the params shown
3067            if not item[2].IsShown():
3068                continue
3069            disfunc = ''
3070            try:
3071                if item[7].__class__.__name__ == 'ComboBox':
3072                    disfunc = str(item[7].GetValue())
3073            except Exception:
3074                logging.error(traceback.format_exc())
3075
3076            # 2D
3077            if self.data.__class__.__name__ == "Data2D":
3078                try:
3079                    check = item[0].GetValue()
3080                except Exception:
3081                    check = None
3082                name = item[1]
3083                value = item[2].GetValue()
3084            # 1D
3085            else:
3086                # for 1D all parameters except orientation
3087                if not item[1] in orient_param:
3088                    try:
3089                        check = item[0].GetValue()
3090                    except:
3091                        check = None
3092                    name = item[1]
3093                    value = item[2].GetValue()
3094
3095            # Bounds
3096            try:
3097                bound_lo = item[5].GetValue()
3098                bound_hi = item[6].GetValue()
3099            except Exception:
3100                # harmless - need to just pass
3101                pass
3102
3103            # add to the content
3104            if disfunc != '':
3105
3106                disfunc = ',' + disfunc
3107            # Need to support array func for copy/paste
3108            try:
3109                if disfunc.count('array') > 0:
3110                    disfunc += ','
3111                    for val in self.values[name]:
3112                        disfunc += ' ' + str(val)
3113                    disfunc += ','
3114                    for weight in self.weights[name]:
3115                        disfunc += ' ' + str(weight)
3116            except Exception:
3117                logging.error(traceback.format_exc())
3118            content += name + ',' + str(check) + ',' + value + disfunc + ',' + \
3119                       bound_lo + ',' + bound_hi + ':'
3120
3121        return content
3122
3123    def get_clipboard(self):
3124        """
3125        Get strings in the clipboard
3126        """
3127        text = ""
3128        # Get text from the clip board
3129        if wx.TheClipboard.Open():
3130            if wx.TheClipboard.IsSupported(wx.DataFormat(wx.DF_TEXT)):
3131                data = wx.TextDataObject()
3132                # get wx dataobject
3133                success = wx.TheClipboard.GetData(data)
3134                # get text
3135                if success:
3136                    text = data.GetText()
3137                else:
3138                    text = ''
3139            # close clipboard
3140            wx.TheClipboard.Close()
3141        return text
3142
3143    def get_paste(self):
3144        """
3145        Paste params from the clipboard
3146        """
3147        text = self.get_clipboard()
3148        flag = self.get_paste_params(text)
3149        self._copy_info(flag)
3150        return flag
3151
3152    def get_paste_params(self, text=''):
3153        """
3154        Get the string copies of the param names and values in the tap
3155        """
3156        context = {}
3157        # put the text into dictionary
3158        lines = text.split(':')
3159        if lines[0] != 'sasview_parameter_values':
3160            self._copy_info(False)
3161            return False
3162        for line in lines[1:-1]:
3163            if len(line) != 0:
3164                item = line.split(',')
3165                check = item[1]
3166                name = item[0]
3167                value = item[2]
3168                # Transfer the text to content[dictionary]
3169                context[name] = [check, value]
3170
3171                # limits
3172                limit_lo = item[3]
3173                context[name].append(limit_lo)
3174                limit_hi = item[4]
3175                context[name].append(limit_hi)
3176
3177            # ToDo: PlugIn this poly disp function for pasting
3178            try:
3179                poly_func = item[5]
3180                context[name].append(poly_func)
3181                try:
3182                    # take the vals and weights for  array
3183                    array_values = item[6].split(' ')
3184                    array_weights = item[7].split(' ')
3185                    val = [float(a_val) for a_val in array_values[1:]]
3186                    weit = [float(a_weit) for a_weit in array_weights[1:]]
3187
3188                    context[name].append(val)
3189                    context[name].append(weit)
3190                except:
3191                    raise
3192            except:
3193                poly_func = ''
3194                context[name].append(poly_func)
3195
3196        # Do it if params exist
3197        if self.parameters:
3198            # go through the parameters
3199            self._get_paste_helper(self.parameters,
3200                                   self.orientation_params, context)
3201
3202            # go through the fittables
3203            self._get_paste_helper(self.fittable_param,
3204                                   self.orientation_params_disp,
3205                                   context)
3206
3207            # go through the fixed params
3208            self._get_paste_helper(self.fixed_param,
3209                                   self.orientation_params_disp, context)
3210
3211            # go through the str params
3212            self._get_paste_helper(self.str_parameters,
3213                                   self.orientation_params, context)
3214
3215            return True
3216        return None
3217
3218    def _get_paste_helper(self, param, orient_param, content):
3219        """
3220        Helping set values of the params
3221
3222        : param param:  parameters
3223        : param orient_param: oritational params
3224        : param content: dictionary [ name, value: name1.value1,...]
3225        """
3226        # go through the str params
3227        for item in param:
3228            # 2D
3229            if self.data.__class__.__name__ == "Data2D":
3230                name = item[1]
3231                if name in content.keys():
3232                    values = content[name]
3233                    check = values[0]
3234                    pd = values[1]
3235
3236                    if name.count('.') > 0:
3237                        # If this is parameter.width, then pd may be a floating
3238                        # point value or it may be an array distribution.
3239                        # Nothing to do for parameter.npts or parameter.nsigmas.
3240                        try:
3241                            float(pd)
3242                            if name.endswith('.npts'):
3243                                pd = int(pd)
3244                        except Exception:
3245                            # continue
3246                            if not pd and pd != '':
3247                                continue
3248                    item[2].SetValue(str(pd))
3249                    if item in self.fixed_param and pd == '':
3250                        # Only array func has pd == '' case.
3251                        item[2].Enable(False)
3252                    else:
3253                        item[2].Enable(True)
3254                    if item[2].__class__.__name__ == "ComboBox":
3255                        if content[name][1] in self.model.fun_list:
3256                            fun_val = self.model.fun_list[content[name][1]]
3257                            self.model.setParam(name, fun_val)
3258                    try:
3259                        item[5].SetValue(str(values[-3]))
3260                        item[6].SetValue(str(values[-2]))
3261                    except Exception:
3262                        # passing as harmless non-update
3263                        pass
3264
3265                    value = content[name][1:]
3266                    self._paste_poly_help(item, value)
3267                    if check == 'True':
3268                        is_true = True
3269                    elif check == 'False':
3270                        is_true = False
3271                    else:
3272                        is_true = None
3273                    if is_true is not None:
3274                        item[0].SetValue(is_true)
3275            # 1D
3276            else:
3277                # for 1D all parameters except orientation
3278                if not item[1] in orient_param:
3279                    name = item[1]
3280                    if name in content.keys():
3281                        check = content[name][0]
3282                        # Avoid changing combox content
3283                        value = content[name][1:]
3284                        pd = value[0]
3285                        if name.count('.') > 0:
3286                            # If this is parameter.width, then pd may be a
3287                            # floating point value or it may be an array
3288                            # distribution. Nothing to do for parameter.npts or
3289                            # parameter.nsigmas.
3290                            try:
3291                                pd = float(pd)
3292                                if name.endswith('.npts'):
3293                                    pd = int(pd)
3294                            except:
3295                                # continue
3296                                if not pd and pd != '':
3297                                    continue
3298                        item[2].SetValue(str(pd))
3299                        if item in self.fixed_param and pd == '':
3300                            # Only array func has pd == '' case.
3301                            item[2].Enable(False)
3302                        else:
3303                            item[2].Enable(True)
3304                        if item[2].__class__.__name__ == "ComboBox":
3305                            if value[0] in self.model.fun_list:
3306                                fun_val = self.model.fun_list[value[0]]
3307                                self.model.setParam(name, fun_val)
3308                                # save state
3309                        try:
3310                            item[5].SetValue(str(value[-3]))
3311                            item[6].SetValue(str(value[-2]))
3312                        except Exception:
3313                            # passing as harmless non-update
3314                            pass
3315
3316                        self._paste_poly_help(item, value)
3317                        if check == 'True':
3318                            is_true = True
3319                        elif check == 'False':
3320                            is_true = False
3321                        else:
3322                            is_true = None
3323                        if is_true is not None:
3324                            item[0].SetValue(is_true)
3325
3326        self.select_param(event=None)
3327        self.Refresh()
3328
3329    def _paste_poly_help(self, item, value):
3330        """
3331        Helps get paste for poly function
3332
3333        *item* is the parameter name
3334
3335        *value* depends on which parameter is being processed, and whether it
3336        has array polydispersity.
3337
3338        For parameters without array polydispersity:
3339
3340            parameter => ['FLOAT', '']
3341            parameter.width => ['FLOAT', 'DISTRIBUTION', '']
3342            parameter.npts => ['FLOAT', '']
3343            parameter.nsigmas => ['FLOAT', '']
3344
3345        For parameters with array polydispersity:
3346
3347            parameter => ['FLOAT', '']
3348            parameter.width => ['FILENAME', 'array', [x1, ...], [w1, ...]]
3349            parameter.npts => ['FLOAT', '']
3350            parameter.nsigmas => ['FLOAT', '']
3351        """
3352        # Do nothing if not setting polydispersity
3353        if len(value[3]) == 0:
3354            return
3355
3356        try:
3357            name = item[7].Name
3358            param_name = name.split('.')[0]
3359            item[7].SetValue(value[1])
3360            selection = item[7].GetCurrentSelection()
3361            dispersity = item[7].GetClientData(selection)
3362            disp_model = dispersity()
3363
3364            if value[1] == 'array':
3365                pd_vals = numpy.array(value[2])
3366                pd_weights = numpy.array(value[3])
3367                if len(pd_vals) == 0 or len(pd_vals) != len(pd_weights):
3368                    msg = ("bad array distribution parameters for %s"
3369                           % param_name)
3370                    raise ValueError(msg)
3371                self._set_disp_cb(True, item=item)
3372                self._set_array_disp_model(name=name,
3373                                           disp=disp_model,
3374                                           values=pd_vals,
3375                                           weights=pd_weights)
3376            else:
3377                self._set_disp_cb(False, item=item)
3378                self._disp_obj_dict[name] = disp_model
3379                self.model.set_dispersion(param_name, disp_model)
3380                self.state._disp_obj_dict[name] = disp_model.type
3381                # TODO: It's not an array, why update values and weights?
3382                self.model._persistency_dict[param_name] = \
3383                    [self.values, self.weights]
3384                self.state.values = self.values
3385                self.state.weights = self.weights
3386
3387        except Exception:
3388            logging.error(traceback.format_exc())
3389            print "Error in BasePage._paste_poly_help: %s" % \
3390                  sys.exc_info()[1]
3391
3392    def _set_disp_cb(self, isarray, item):
3393        """
3394        Set cb for array disp
3395        """
3396        if isarray:
3397            item[0].SetValue(False)
3398            item[0].Enable(False)
3399            item[2].Enable(False)
3400            item[3].Show(False)
3401            item[4].Show(False)
3402            item[5].SetValue('')
3403            item[5].Enable(False)
3404            item[6].SetValue('')
3405            item[6].Enable(False)
3406        else:
3407            item[0].Enable()
3408            item[2].Enable()
3409            item[3].Show(True)
3410            item[4].Show(True)
3411            item[5].Enable()
3412            item[6].Enable()
3413
3414    def update_pinhole_smear(self):
3415        """
3416            Method to be called by sub-classes
3417            Moveit; This method doesn't belong here
3418        """
3419        print "BasicPage.update_pinhole_smear was called: skipping"
3420        return
3421
3422    def _read_category_info(self):
3423        """
3424        Reads the categories in from file
3425        """
3426        # # ILL mod starts here - July 2012 kieranrcampbell@gmail.com
3427        self.master_category_dict = defaultdict(list)
3428        self.by_model_dict = defaultdict(list)
3429        self.model_enabled_dict = defaultdict(bool)
3430        categorization_file = CategoryInstaller.get_user_file()
3431        with open(categorization_file, 'rb') as f:
3432            self.master_category_dict = json.load(f)
3433        self._regenerate_model_dict()
3434
3435    def _regenerate_model_dict(self):
3436        """
3437        regenerates self.by_model_dict which has each model name as the
3438        key and the list of categories belonging to that model
3439        along with the enabled mapping
3440        """
3441        self.by_model_dict = defaultdict(list)
3442        for category in self.master_category_dict:
3443            for (model, enabled) in self.master_category_dict[category]:
3444                self.by_model_dict[model].append(category)
3445                self.model_enabled_dict[model] = enabled
3446
3447    def _populate_listbox(self):
3448        """
3449        fills out the category list box
3450        """
3451        uncat_str = 'Customized Models'
3452        self._read_category_info()
3453
3454        self.categorybox.Clear()
3455        cat_list = sorted(self.master_category_dict.keys())
3456        if uncat_str not in cat_list:
3457            cat_list.append(uncat_str)
3458
3459        for category in cat_list:
3460            if category != '':
3461                self.categorybox.Append(category)
3462
3463        if self.categorybox.GetSelection() == wx.NOT_FOUND:
3464            self.categorybox.SetSelection(0)
3465        else:
3466            self.categorybox.SetSelection(
3467                self.categorybox.GetSelection())
3468        # self._on_change_cat(None)
3469
3470    def _on_change_cat(self, event):
3471        """
3472        Callback for category change action
3473        """
3474        self.model_name = None
3475        category = self.categorybox.GetStringSelection()
3476        if category is None:
3477            return
3478        self.model_box.Clear()
3479
3480        if category == 'Customized Models':
3481            for model in self.model_list_box[category]:
3482                str_m = str(model).split(".")[0]
3483                self.model_box.Append(str_m)
3484
3485        else:
3486            for (model, enabled) in sorted(self.master_category_dict[category],
3487                                           key=lambda name: name[0]):
3488                if(enabled):
3489                    self.model_box.Append(model)
3490
3491    def _fill_model_sizer(self, sizer):
3492        """
3493        fill sizer containing model info
3494        """
3495        # This should only be called once per fit tab
3496        # print "==== Entering _fill_model_sizer"
3497        # Add model function Details button in fitpanel.
3498        # The following 3 lines are for Mac. Let JHC know before modifying...
3499        title = "Model"
3500        self.formfactorbox = None
3501        self.multifactorbox = None
3502        self.mbox_description = wx.StaticBox(self, wx.ID_ANY, str(title))
3503        boxsizer1 = wx.StaticBoxSizer(self.mbox_description, wx.VERTICAL)
3504        sizer_cat = wx.BoxSizer(wx.HORIZONTAL)
3505        self.mbox_description.SetForegroundColour(wx.RED)
3506        wx_id = self._ids.next()
3507        self.model_func = wx.Button(self, wx_id, 'Help', size=(80, 23))
3508        self.model_func.Bind(wx.EVT_BUTTON, self.on_function_help_clicked,
3509                             id=wx_id)
3510        self.model_func.SetToolTipString("Full Model Function Help")
3511        wx_id = self._ids.next()
3512        self.model_help = wx.Button(self, wx_id, 'Description', size=(80, 23))
3513        self.model_help.Bind(wx.EVT_BUTTON, self.on_model_help_clicked,
3514                             id=wx_id)
3515        self.model_help.SetToolTipString("Short Model Function Description")
3516        wx_id = self._ids.next()
3517        self.model_view = wx.Button(self, wx_id, "Show 2D", size=(80, 23))
3518        self.model_view.Bind(wx.EVT_BUTTON, self._onModel2D, id=wx_id)
3519        hint = "toggle view of model from 1D to 2D  or 2D to 1D"
3520        self.model_view.SetToolTipString(hint)
3521
3522        cat_set_box = wx.StaticBox(self, wx.ID_ANY, 'Category')
3523        sizer_cat_box = wx.StaticBoxSizer(cat_set_box, wx.HORIZONTAL)
3524        sizer_cat_box.SetMinSize((200, 50))
3525        self.categorybox = wx.ComboBox(self, wx.ID_ANY,
3526                                       style=wx.CB_READONLY)
3527        self.categorybox.SetToolTip(wx.ToolTip("Select a Category/Type"))
3528        self._populate_listbox()
3529        wx.EVT_COMBOBOX(self.categorybox, wx.ID_ANY, self._show_combox)
3530        # self.shape_rbutton = wx.RadioButton(self, wx.ID_ANY, 'Shapes',
3531        #                                     style=wx.RB_GROUP)
3532        # self.shape_indep_rbutton = wx.RadioButton(self, wx.ID_ANY,
3533        #                                          "Shape-Independent")
3534        # self.struct_rbutton = wx.RadioButton(self, wx.ID_ANY,
3535        #                                     "Structure Factor ")
3536        # self.plugin_rbutton = wx.RadioButton(self, wx.ID_ANY,
3537        #                                     "Uncategorized")
3538
3539        # self.Bind(wx.EVT_RADIOBUTTON, self._show_combox,
3540        #                   id=self.shape_rbutton.GetId())
3541        # self.Bind(wx.EVT_RADIOBUTTON, self._show_combox,
3542        #                    id=self.shape_indep_rbutton.GetId())
3543        # self.Bind(wx.EVT_RADIOBUTTON, self._show_combox,
3544        #                    id=self.struct_rbutton.GetId())
3545        # self.Bind(wx.EVT_RADIOBUTTON, self._show_combox,
3546        #                    id=self.plugin_rbutton.GetId())
3547        # MAC needs SetValue
3548
3549        show_cat_button = wx.Button(self, wx.ID_ANY, "Modify")
3550        cat_tip = "Modify model categories \n"
3551        cat_tip += "(also accessible from the menu bar)."
3552        show_cat_button.SetToolTip(wx.ToolTip(cat_tip))
3553        show_cat_button.Bind(wx.EVT_BUTTON, self._on_modify_cat)
3554        sizer_cat_box.Add(self.categorybox, 1, wx.RIGHT, 3)
3555        sizer_cat_box.Add((10, 10))
3556        sizer_cat_box.Add(show_cat_button)
3557        # self.shape_rbutton.SetValue(True)
3558
3559        sizer_radiobutton = wx.GridSizer(2, 2, 5, 5)
3560        # sizer_radiobutton.Add(self.shape_rbutton)
3561        # sizer_radiobutton.Add(self.shape_indep_rbutton)
3562        sizer_radiobutton.Add((5, 5))
3563        sizer_radiobutton.Add(self.model_view, 1, wx.RIGHT, 5)
3564        # sizer_radiobutton.Add(self.plugin_rbutton)
3565        # sizer_radiobutton.Add(self.struct_rbutton)
3566        # sizer_radiobutton.Add((5,5))
3567        sizer_radiobutton.Add(self.model_help, 1, wx.RIGHT | wx.LEFT, 5)
3568        # sizer_radiobutton.Add((5,5))
3569        sizer_radiobutton.Add(self.model_func, 1, wx.RIGHT, 5)
3570        sizer_cat.Add(sizer_cat_box, 1, wx.LEFT, 2.5)
3571        sizer_cat.Add(sizer_radiobutton)
3572        sizer_selection = wx.BoxSizer(wx.HORIZONTAL)
3573        mutifactor_selection = wx.BoxSizer(wx.HORIZONTAL)
3574
3575        self.text1 = wx.StaticText(self, wx.ID_ANY, "")
3576        self.text2 = wx.StaticText(self, wx.ID_ANY, "P(Q)*S(Q)")
3577        self.mutifactor_text = wx.StaticText(self, wx.ID_ANY, "No. of Shells: ")
3578        self.mutifactor_text1 = wx.StaticText(self, wx.ID_ANY, "")
3579        self.show_sld_button = wx.Button(self, wx.ID_ANY, "Show SLD Profile")
3580        self.show_sld_button.Bind(wx.EVT_BUTTON, self._on_show_sld)
3581
3582        self.formfactorbox = wx.ComboBox(self, wx.ID_ANY, style=wx.CB_READONLY)
3583        self.formfactorbox.SetToolTip(wx.ToolTip("Select a Model"))
3584        if self.model is not None:
3585            self.formfactorbox.SetValue(self.model.name)
3586        self.structurebox = wx.ComboBox(self, wx.ID_ANY, style=wx.CB_READONLY)
3587        self.multifactorbox = wx.ComboBox(self, wx.ID_ANY, style=wx.CB_READONLY)
3588        self.initialize_combox()
3589        wx.EVT_COMBOBOX(self.formfactorbox, wx.ID_ANY, self._on_select_model)
3590
3591        wx.EVT_COMBOBOX(self.structurebox, wx.ID_ANY, self._on_select_model)
3592        wx.EVT_COMBOBOX(self.multifactorbox, wx.ID_ANY, self._on_select_model)
3593        # check model type to show sizer
3594        if self.model is not None:
3595            print "_set_model_sizer_selection: disabled."
3596            # self._set_model_sizer_selection(self.model)
3597
3598        sizer_selection.Add(self.text1)
3599        sizer_selection.Add((10, 5))
3600        sizer_selection.Add(self.formfactorbox)
3601        sizer_selection.Add((5, 5))
3602        sizer_selection.Add(self.text2)
3603        sizer_selection.Add((5, 5))
3604        sizer_selection.Add(self.structurebox)
3605
3606        mutifactor_selection.Add((13, 5))
3607        mutifactor_selection.Add(self.mutifactor_text)
3608        mutifactor_selection.Add(self.multifactorbox)
3609        mutifactor_selection.Add((5, 5))
3610        mutifactor_selection.Add(self.mutifactor_text1)
3611        mutifactor_selection.Add((10, 5))
3612        mutifactor_selection.Add(self.show_sld_button)
3613
3614        boxsizer1.Add(sizer_cat)
3615        boxsizer1.Add((10, 10))
3616        boxsizer1.Add(sizer_selection)
3617        boxsizer1.Add((10, 10))
3618        boxsizer1.Add(mutifactor_selection)
3619
3620        self._set_multfactor_combobox()
3621        self.multifactorbox.SetSelection(1)
3622        self.show_sld_button.Hide()
3623        sizer.Add(boxsizer1, 0, wx.EXPAND | wx.ALL, 10)
3624        sizer.Layout()
3625
3626    def on_smear_helper(self, update=False):
3627        """
3628        Help for onSmear if implemented
3629
3630        :param update: force or not to update
3631        """
3632    def reset_page(self, state, first=False):
3633        """
3634        reset the state  if implemented
3635        """
3636    def onSmear(self, event):
3637        """
3638        Create a smear object if implemented
3639        """
3640    def onPinholeSmear(self, event):
3641        """
3642        Create a custom pinhole smear object if implemented
3643        """
3644    def onSlitSmear(self, event):
3645        """
3646        Create a custom slit smear object if implemented
3647        """
3648    def update_slit_smear(self):
3649        """
3650        called by kill_focus on pinhole TextCntrl
3651        to update the changes if implemented
3652        """
3653    def select_param(self, event):
3654        """
3655        Select TextCtrl  checked if implemented
3656        """
3657    def set_data(self, data=None):
3658        """
3659        Sets data if implemented
3660        """
3661    def _is_2D(self):
3662        """
3663        Check if data_name is Data2D if implemented
3664        """
3665    def _on_select_model(self, event=None):
3666        """
3667        call back for model selection if implemented
3668        """
3669    def get_weight_flag(self):
3670        """
3671        Get flag corresponding to a given weighting dI data if implemented
3672        """
3673    def _set_sizer_dispersion(self):
3674        """
3675        draw sizer for dispersity if implemented
3676        """
3677    def get_all_checked_params(self):
3678        """
3679        Found all parameters current check and add them to list of parameters
3680        to fit if implemented
3681        """
3682    def show_npts2fit(self):
3683        """
3684        setValue Npts for fitting if implemented
3685        """
3686    def _onModel2D(self, event):
3687        """
3688        toggle view of model from 1D to 2D  or 2D from 1D if implemented
3689        """
3690
3691
3692class ModelTextCtrl(wx.TextCtrl):
3693    """
3694    Text control for model and fit parameters.
3695    Binds the appropriate events for user interactions.
3696    Default callback methods can be overwritten on initialization
3697
3698    :param kill_focus_callback: callback method for EVT_KILL_FOCUS event
3699    :param set_focus_callback:  callback method for EVT_SET_FOCUS event
3700    :param mouse_up_callback:   callback method for EVT_LEFT_UP event
3701    :param text_enter_callback: callback method for EVT_TEXT_ENTER event
3702
3703    """
3704    # Set to True when the mouse is clicked while whole string is selected
3705    full_selection = False
3706    # Call back for EVT_SET_FOCUS events
3707    _on_set_focus_callback = None
3708
3709    def __init__(self, parent, id=-1,
3710                 value=wx.EmptyString,
3711                 pos=wx.DefaultPosition,
3712                 size=wx.DefaultSize,
3713                 style=0,
3714                 validator=wx.DefaultValidator,
3715                 name=wx.TextCtrlNameStr,
3716                 kill_focus_callback=None,
3717                 set_focus_callback=None,
3718                 mouse_up_callback=None,
3719                 text_enter_callback=None):
3720
3721        wx.TextCtrl.__init__(self, parent, id, value, pos,
3722                             size, style, validator, name)
3723
3724        # Bind appropriate events
3725        self._on_set_focus_callback = parent.onSetFocus \
3726            if set_focus_callback is None else set_focus_callback
3727        self.Bind(wx.EVT_SET_FOCUS, self._on_set_focus)
3728        self.Bind(wx.EVT_KILL_FOCUS, self._silent_kill_focus
3729        if kill_focus_callback is None else kill_focus_callback)
3730        self.Bind(wx.EVT_TEXT_ENTER, parent._onparamEnter
3731        if text_enter_callback is None else text_enter_callback)
3732        if not ON_MAC:
3733            self.Bind(wx.EVT_LEFT_UP, self._highlight_text
3734            if mouse_up_callback is None else mouse_up_callback)
3735
3736    def _on_set_focus(self, event):
3737        """
3738        Catch when the text control is set in focus to highlight the whole
3739        text if necessary
3740
3741        :param event: mouse event
3742
3743        """
3744        event.Skip()
3745        self.full_selection = True
3746        return self._on_set_focus_callback(event)
3747
3748    def _highlight_text(self, event):
3749        """
3750        Highlight text of a TextCtrl only of no text has be selected
3751
3752        :param event: mouse event
3753
3754        """
3755        # Make sure the mouse event is available to other listeners
3756        event.Skip()
3757        control = event.GetEventObject()
3758        if self.full_selection:
3759            self.full_selection = False
3760            # Check that we have a TextCtrl
3761            if issubclass(control.__class__, wx.TextCtrl):
3762                # Check whether text has been selected,
3763                # if not, select the whole string
3764                (start, end) = control.GetSelection()
3765                if start == end:
3766                    control.SetSelection(-1, -1)
3767
3768    def _silent_kill_focus(self, event):
3769        """
3770        Save the state of the page
3771        """
3772
3773        event.Skip()
3774        # pass
Note: See TracBrowser for help on using the repository browser.