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

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalcmagnetic_scattrelease-4.2.2ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since c5c247e was c5c247e, checked in by Tim Snow <tim.snow@…>, 7 years ago

Put in a resubmission time constraint

In order to close ticket #14, if a fitting is put in for submission
within 0.1 sec of another fitting, and a fitting is already taking
place, then it will not be submitted to the fitting engine.

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