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

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

Added patch to handle formfactor and category names that aren't saved in v4.0.1 and earlier. Start on loading str_parameters, but not finished.

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