source: sasview/sansview/perspectives/fitting/fitpage.py @ 1b07935d

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 1b07935d was 1b07935d, checked in by Gervaise Alina <gervyh@…>, 16 years ago

creating a panel for model display

  • Property mode set to 100644
File size: 22.8 KB
Line 
1import sys
2import wx
3import wx.lib
4import numpy
5import copy
6
7from sans.guicomm.events import StatusEvent   
8(ModelEventbox, EVT_MODEL_BOX) = wx.lib.newevent.NewEvent()
9_BOX_WIDTH = 80
10
11def format_number(value, high=False):
12    """
13        Return a float in a standardized, human-readable formatted string
14    """
15    try: 
16        value = float(value)
17    except:
18        print "returning 0"
19        return "0"
20   
21    if high:
22        return "%-6.4g" % value
23    else:
24        return "%-5.3g" % value
25
26   
27class FitPage(wx.Panel):
28    """
29        FitPanel class contains fields allowing to display results when
30        fitting  a model and one data
31        @note: For Fit to be performed the user should check at least one parameter
32        on fit Panel window.
33 
34    """
35    ## Internal name for the AUI manager
36    window_name = "Fit page"
37    ## Title to appear on top of the window
38    window_caption = "Fit Page"
39   
40   
41    def __init__(self, parent, *args, **kwargs):
42        wx.Panel.__init__(self, parent, *args, **kwargs)
43        """
44            Initialization of the Panel
45        """
46        self.manager = None
47        self.parent  = parent
48        self.event_owner=None
49        #panel interface
50        self.vbox  = wx.BoxSizer(wx.VERTICAL)
51        self.sizer4 = wx.GridBagSizer(5,5)
52        self.sizer3 = wx.GridBagSizer(5,5)
53        self.sizer2 = wx.GridBagSizer(5,5)
54        self.sizer1 = wx.GridBagSizer(5,5)
55        self.DataSource      = wx.TextCtrl(self, -1,size=(_BOX_WIDTH,20))
56        self.DataSource.SetToolTipString("name of data to fit")
57        self.modelbox = wx.ComboBox(self, -1)
58        id = wx.NewId()
59        self.btFit =wx.Button(self,id,'Fit')
60        self.btFit.Bind(wx.EVT_BUTTON, self.onFit,id=id)
61        self.btFit.SetToolTipString("Perform fit.")
62        self.vbox.Add(self.sizer3)
63        self.vbox.Add(self.sizer2)
64        self.vbox.Add(self.sizer4)
65        self.vbox.Add(self.sizer1)
66       
67        ix = 0
68        iy = 1
69        self.sizer3.Add(wx.StaticText(self, -1, 'Data Source'),(iy,ix),\
70                 (1,1), wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 15)
71        ix += 1
72        self.sizer3.Add(self.DataSource,(iy,ix),(1,1), wx.EXPAND|wx.ADJUST_MINSIZE, 0)
73        ix += 1
74        self.sizer3.Add((20,20),(iy,ix),(1,1),wx.RIGHT|wx.EXPAND|wx.ADJUST_MINSIZE,0)
75        ix = 0
76        iy += 1
77        self.sizer3.Add(wx.StaticText(self,-1,'Model'),(iy,ix),(1,1)\
78                  , wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 15)
79        ix += 1
80        self.sizer3.Add(self.modelbox,(iy,ix),(1,1),  wx.EXPAND|wx.ADJUST_MINSIZE, 0)
81        ix = 1
82        iy = 1
83        self.text4_1 = wx.StaticText(self, -1, 'Min')
84        self.sizer4.Add(self.text4_1,(iy, ix),(1,1),\
85                            wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 15)
86        self.text4_1.Hide()
87        ix += 2
88        self.text4_2 = wx.StaticText(self, -1, 'Max')
89        self.sizer4.Add(self.text4_2,(iy, ix),(1,1),\
90                            wx.EXPAND|wx.ADJUST_MINSIZE, 0)
91        self.text4_2.Hide()
92        ix = 0
93        iy += 1
94        #set maximum range for x in linear scale
95        self.text4_3 = wx.StaticText(self, -1, 'Maximum Data\n Range (Linear)', style=wx.ALIGN_LEFT)
96        self.sizer4.Add(self.text4_3,(iy,ix),(1,1),\
97                   wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 15)
98        self.text4_3.Hide()
99        ix += 1
100        self.xmin    = wx.TextCtrl(self, -1,size=(_BOX_WIDTH,20))
101        self.xmin.SetToolTipString("Minimun value of x in linear scale.")
102        self.sizer4.Add(self.xmin,(iy, ix),(1,1), wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 0)
103        self.xmin.Bind(wx.EVT_KILL_FOCUS, self._onTextEnter)
104        self.xmin.Hide()
105        ix += 2
106        self.xmax    = wx.TextCtrl(self, -1,size=(_BOX_WIDTH,20))
107        self.xmax.SetToolTipString("Maximum value of x in linear scale.")
108        self.sizer4.Add(self.xmax,(iy,ix),(1,1), wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 0)
109        self.xmax.Bind(wx.EVT_KILL_FOCUS, self._onTextEnter)
110        self.xmax.Hide()
111        #Set chisqr  result into TextCtrl
112        ix = 0
113        iy = 1
114        self.text1_1 = wx.StaticText(self, -1, 'Chi2/dof', style=wx.ALIGN_LEFT)
115        self.sizer1.Add(self.text1_1,(iy,ix),(1,1),\
116                   wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 15)
117        ix += 1
118        self.tcChi    = wx.TextCtrl(self, -1,size=(_BOX_WIDTH,20))
119        self.tcChi.SetToolTipString("Chi^2 over degrees of freedom.")
120        self.sizer1.Add(self.tcChi,(iy,ix),(1,1), wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 0)
121        ix +=2
122        self.sizer1.Add(self.btFit,(iy,ix),(1,1), wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 0)
123       
124        # contains link between  model ,all its parameters, and panel organization
125        self.parameters=[]
126        #contains link between a model and selected parameters to fit
127        self.param_toFit=[]
128        # model on which the fit would be performed
129        self.model=None
130        # preview selected model name
131        self.prevmodel_name=None
132        # flag to check if the user has selected a new model in the combox box
133        self.model_hasChanged=False
134        #flag to check if the user has selected a new data
135        self.data_hasChanged=False
136        #dictionary of model name and model class
137        self.model_list_box={}
138        # Data1D to make a deep comparison between 2 Data1D for checking data
139        #change
140        from sans.guitools.plottables import Data1D
141        self.prevData = Data1D(x=[], y=[],dx=None, dy=None)
142        self.prevData.name= None
143       
144        self.data=None
145        self.vbox.Layout()
146        self.vbox.Fit(self) 
147        self.SetSizer(self.vbox)
148        self.Centre()
149       
150       
151    def set_owner(self,owner):
152        """
153            set owner of fitpage
154            @param owner: the class responsible of plotting
155        """
156        self.event_owner=owner   
157   
158 
159    def set_manager(self, manager):
160        """
161             set panel manager
162             @param manager: instance of plugin fitting
163        """
164        self.manager = manager
165 
166         
167    def _DataNameEnter(self):
168        """
169            reset the panel when a new data is selected
170        """
171        if len(self.parameters )>0:
172            for item in self.parameters:
173                item[0].SetValue(False)
174                wx.EVT_CHECKBOX(self, item[0].GetId(), self.select_param)
175                item[2].Hide()
176                item[3].Clear()
177                item[3].Hide()
178                self.xmax.Disable()
179                self.xmin.Disable()
180                self.text1_1.Hide()
181                self.tcChi.Clear()
182                self.vbox.Layout() 
183                self.GrandParent.GetSizer().Layout()
184               
185               
186    def copy_data(self,dataset):
187        """
188             copy a select data in the panel to compared with the previous selected data
189             @param dataset: the data selected
190             @note : everything a data is selected, the panel check is it is different
191             from the previous selected data
192        """
193       
194        try:
195            if dataset !=None:
196                self.prevData.x= copy.deepcopy(dataset.x)
197                self.prevData.y= copy.deepcopy(dataset.y)
198                self.prevData.name=dataset.name
199                if dataset.dy==None:
200                    self.prevData.dy= copy.deepcopy(dataset.dy)
201        except:
202            raise ValueError, " copy_data: cannot copy data" 
203       
204       
205    def onFit(self,event):
206        """ signal for fitting"""
207         
208        flag=self.checkFitRange()
209        self.set_manager(self.manager)
210     
211        qmin=float(self.xmin.GetValue())
212        qmax =float( self.xmax.GetValue())
213        if len(self.param_toFit) >0 and flag==True:
214            #self.manager._on_single_fit(model=self.model,qmin=qmin,qmax=qmax)
215            self.manager._on_single_fit(qmin=qmin,qmax=qmax)
216        else:
217              wx.PostEvent(self.parent.GrandParent, StatusEvent(status=\
218                            "Select at least on parameter to fit "))
219    def populate_box(self, dict):
220        """
221            Populate each combox box of each page
222            @param page: the page to populate
223        """
224        id=0
225        self.model_list_box=dict
226        for item in self.model_list_box.itervalues():
227            if hasattr(item, "name"):
228                name = item.name
229            else:
230                name = item.__name__
231           
232            self.modelbox.Insert(name,int(id))
233            id+=1
234           
235            wx.EVT_COMBOBOX(self.modelbox,-1, self._on_select_model) 
236        return 0
237   
238   
239    def _on_select_model(self,event):
240        """
241            react when a model is selected from page's combo box
242            post an event to its owner to draw an appropriate theory
243        """
244        for item in self.model_list_box.itervalues():
245            model=item()
246            if hasattr(model, "name"):
247                name = model.name
248            else:
249                name = model.__class__.__name__
250            try:
251                if name ==event.GetString():
252                    evt = ModelEventbox(model=model,name=name)
253                    wx.PostEvent(self.event_owner, evt)
254            except:
255                raise #ValueError,"model.name is not equal to model class name"
256
257
258   
259    def _onTextEnter(self,event):
260        """
261            set a flag to determine if the fitting range entered by the user is valid
262        """
263        try:
264            flag=self.checkFitRange()
265            if flag==True and self.model!=None:
266                 self.manager.redraw_model(float(self.xmin.GetValue())\
267                                               ,float(self.xmax.GetValue()))
268        except:
269            wx.PostEvent(self.parent.GrandParent, StatusEvent(status=\
270                            "Drawing  Error:wrong value entered %s"% sys.exc_value))
271       
272    def checkFitRange(self):
273        """
274            Check the validity of fitting range
275            @note: xmin should always be less than xmax or else each control box
276            background is colored in pink.
277        """
278       
279        flag = True
280        valueMin = self.xmin.GetValue()
281        valueMax = self.xmax.GetValue()
282        # Check for possible values entered
283       
284        try:
285            if (float(valueMax)> float(valueMin)):
286                self.xmax.SetBackgroundColour(wx.WHITE)
287                self.xmin.SetBackgroundColour(wx.WHITE)
288            else:
289                flag = False
290                self.xmin.SetBackgroundColour("pink")
291                self.xmax.SetBackgroundColour("pink")     
292        except:
293            flag = False
294            self.xmin.SetBackgroundColour("pink")
295            self.xmax.SetBackgroundColour("pink")
296           
297        self.xmin.Refresh()
298        self.xmax.Refresh()
299        return flag
300   
301    def check_data_change(self,dataset):
302        """
303             check if data selected has changed and set flag self.data_hasChanged
304             has true is changed or false is unchanged
305             @param dataset: data selected
306        """
307        self.data_hasChanged=False
308        if self.prevData.__class__ !=dataset.__class__:
309            self.data_hasChanged=True
310           
311        elif self.prevData.name != dataset.name:
312            self.data_hasChanged=True
313           
314        elif len(self.prevData.x) != len(self.prevData.y):
315            self.data_hasChanged=True
316           
317        else:
318            for i in range(len(dataset.x)):
319                if self.prevData.x[i] !=dataset.x[i]:
320                    self.data_hasChanged=True
321                    break
322               
323                if self.prevData.y[i] !=dataset.y[i]:
324                    self.data_hasChanged=True
325                    break
326               
327                if dataset.dy !=None:
328                    if self.prevData.dy[i] !=dataset.dy[i]:
329                        self.data_hasChanged=True
330                        break
331                   
332                   
333    def set_data_name(self,dataset):
334        """
335            set data's name.if data has changed reset the panel and xmin and xmax
336            @param name: data 's name
337            @attention:  still  haven't find a better way to display Q name and unit
338            for xmin and xmax range sizer
339        """
340        self.check_data_change(dataset)
341        if self.data_hasChanged==True:
342            self._DataNameEnter()
343        self.data=dataset
344        self.copy_data(dataset)
345        #Displaying Data information
346        self.DataSource.SetValue(str(dataset.name))
347        self._xaxis,self._xunit=dataset.get_xaxis()
348        self.text4_3.SetLabel(self._xaxis+"["+self._xunit+"]")
349        self.text4_1.Show()
350        self.text4_2.Show()
351        self.text4_3.Show()
352       
353        self.xmin.SetValue(format_number(min(dataset.x)))
354        self.xmin.Show()
355
356        self.xmax.SetValue(format_number(max(dataset.x)))
357        self.xmax.Show()
358       
359        if ((len(self.param_toFit ) >0) and self.DataSource.GetValue()and \
360            self.modelbox.GetValue() and (self.model_hasChanged ==False)):
361            self.xmin.Enable()
362            self.xmax.Enable()
363        else:
364            self.xmin.Disable()
365            self.xmax.Disable()
366           
367        self.vbox.Layout()
368        self.GrandParent.GetSizer().Layout()
369       
370       
371    def set_model_name(self,name):
372        """
373            set model name. set also self.model_hasChanged to true is the model
374            type has changed or false if it didn't
375            @param name: model 's name
376        """
377        self.model_hasChanged=False
378        if (name != self.prevmodel_name):
379            self.model_hasChanged=True
380        self.tcChi.Clear()
381        #self.modelbox.SetValue(str(name))
382        self.prevmodel_name=self.modelbox.GetValue()
383       
384           
385    def get_model_box(self): 
386        """ return reference to combox box self.model"""
387        return self.modelbox
388
389   
390    def get_param_list(self):
391        """
392            @return self.param_toFit: list containing  references to TextCtrl
393            checked.Theses TextCtrl will allow reference to parameters to fit.
394            @raise: if return an empty list of parameter fit will nnote work
395            properly so raise ValueError,"missing parameter to fit"
396        """
397        if self.param_toFit !=[]:
398            return self.param_toFit
399        else:
400            raise ValueError,"missing parameter to fit"
401       
402       
403    def set_panel(self,model):
404        """
405            Build the panel from the model content
406            @param model: the model selected in combo box for fitting purpose
407        """
408   
409        self.sizer2.Clear(True)
410        self.parameters = []
411        self.param_toFit=[]
412        self.model = model
413        keys = self.model.getParamList()
414        keys.sort()
415        iy = 1
416        ix = 0
417        self.cb1 = wx.CheckBox(self, -1,'Parameters', (10, 10))
418        wx.EVT_CHECKBOX(self, self.cb1.GetId(), self.select_all_param)
419        self.sizer2.Add(self.cb1,(iy, ix),(1,1),\
420                          wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 15)
421        ix +=1
422        self.text2_2 = wx.StaticText(self, -1, 'Values')
423        self.sizer2.Add(self.text2_2,(iy, ix),(1,1),\
424                            wx.EXPAND|wx.ADJUST_MINSIZE, 0) 
425        ix +=2
426        self.text2_3 = wx.StaticText(self, -1, 'Errors')
427        self.sizer2.Add(self.text2_3,(iy, ix),(1,1),\
428                            wx.EXPAND|wx.ADJUST_MINSIZE, 0)
429        self.text2_3.Hide() 
430        ix +=1
431        self.text2_4 = wx.StaticText(self, -1, 'Units')
432        self.sizer2.Add(self.text2_4,(iy, ix),(1,1),\
433                            wx.EXPAND|wx.ADJUST_MINSIZE, 0) 
434        self.text2_4.Hide()
435        for item in keys:
436            iy += 1
437            ix = 0
438
439            cb = wx.CheckBox(self, -1, item, (10, 10))
440            cb.SetValue(False)
441            self.sizer2.Add( cb,( iy, ix),(1,1),  wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 15)
442            wx.EVT_CHECKBOX(self, cb.GetId(), self.select_param)
443           
444            ix += 1
445            value= self.model.getParam(item)
446            ctl1 = wx.TextCtrl(self, -1, size=(_BOX_WIDTH,20), style=wx.TE_PROCESS_ENTER)
447            ctl1.SetValue(str (format_number(value)))
448            ctl1.Bind(wx.EVT_KILL_FOCUS, self._onparamEnter)
449            self.sizer2.Add(ctl1, (iy,ix),(1,1), wx.EXPAND|wx.ADJUST_MINSIZE, 0)
450            ix += 1
451            text2=wx.StaticText(self, -1, '+/-')
452            self.sizer2.Add(text2,(iy, ix),(1,1),\
453                            wx.EXPAND|wx.ADJUST_MINSIZE, 0) 
454            text2.Hide() 
455            ix += 1
456            ctl2 = wx.TextCtrl(self, -1, size=(_BOX_WIDTH,20), style=wx.TE_PROCESS_ENTER)
457            self.sizer2.Add(ctl2, (iy,ix),(1,1), wx.EXPAND|wx.ADJUST_MINSIZE, 0)
458            ctl2.Hide()
459            ix +=1
460            # Units
461            try:
462                units = wx.StaticText(self, -1, self.model.details[item][0], style=wx.ALIGN_LEFT)
463            except:
464                units = wx.StaticText(self, -1, "", style=wx.ALIGN_LEFT)
465             
466            self.sizer2.Add(units, (iy,ix),(1,1),  wx.EXPAND|wx.ADJUST_MINSIZE, 0)
467            #save data
468            self.parameters.append([cb,ctl1,text2,ctl2])
469        #Display units text on panel
470        for item in keys:   
471            if self.model.details[item][0]!='':
472                self.text2_4.Show()
473                break
474            else:
475                self.text2_4.Hide()
476        #Disable or enable fit button
477        if (self.modelbox.GetValue() and self.DataSource.GetValue()):
478            if not (len(self.param_toFit ) >0):
479                self.xmin.Disable()
480                self.xmax.Disable()
481            else:
482                self.xmin.Enable()
483                self.xmax.Enable()
484        else:
485            self.xmin.Disable()
486            self.xmax.Disable()
487     
488        self.vbox.Layout()
489        self.GrandParent.GetSizer().Layout()
490       
491   
492       
493    def _onparamEnter(self,event):
494        """
495            when enter value on panel redraw model according to changed
496        """
497        self.set_model_parameter()
498       
499    def set_model_parameter(self):
500        if len(self.parameters) !=0 and self.model !=None:
501            for item in self.parameters:
502                try:
503                     name=str(item[0].GetLabelText())
504                     value= float(item[1].GetValue())
505                     
506                     self.model.setParam(name,value)
507                     self.manager.redraw_model(float(self.xmin.GetValue())\
508                                               ,float(self.xmax.GetValue()))
509                except:
510                     wx.PostEvent(self.parent.GrandParent, StatusEvent(status=\
511                            "Drawing  Error:wrong value entered : %s"% sys.exc_value))
512    def select_all_param(self,event): 
513        """
514             set to true or false all checkBox given the main checkbox value cb1
515        """
516        self.param_toFit=[]
517        if  self.parameters !=[]:
518            if  self.cb1.GetValue()==True:
519                for item in self.parameters:
520                   
521                    item[0].SetValue(True)
522                    list= [item[0],item[1],item[2],item[3]]
523                    self.param_toFit.append(list )
524                if (self.modelbox.GetValue() and self.DataSource.GetValue()):
525                    if not (len(self.param_toFit ) >0):
526                        self.xmin.Disable()
527                        self.xmax.Disable()
528                    else:
529                        self.xmin.Enable()
530                        self.xmax.Enable()
531            else:
532                for item in self.parameters:
533                    item[0].SetValue(False)
534                self.param_toFit=[]
535             
536                self.xmin.Disable()
537                self.xmax.Disable()
538               
539               
540    def select_param(self,event):
541        """
542            Select TextCtrl  checked for fitting purpose and stores them
543            in  self.param_toFit=[] list
544        """
545        self.param_toFit=[]
546        for item in self.parameters:
547            if item[0].GetValue()==True:
548                list= [item[0],item[1],item[2],item[3]]
549                self.param_toFit.append(list ) 
550            else:
551                if item in self.param_toFit:
552                    self.param_toFit.remove(item)
553        if len(self.parameters)==len(self.param_toFit):
554            self.cb1.SetValue(True)
555        else:
556            self.cb1.SetValue(False)
557        if (self.modelbox.GetValue() and self.DataSource.GetValue()):
558            if not (len(self.param_toFit ) >0):
559                self.xmin.Disable()
560                self.xmax.Disable()
561            else:
562                self.xmin.Enable()
563                self.xmax.Enable()
564        else:
565            self.xmin.Disable()
566            self.xmax.Disable()
567   
568       
569 
570    def onsetValues(self,chisqr, out,cov):
571        """
572            Build the panel from the fit result
573            @param chisqr:Value of the goodness of fit metric
574            @param out:list of parameter with the best value found during fitting
575            @param cov:Covariance matrix
576       
577        """
578        #print "fitting : onsetvalues out",out
579        self.tcChi.Clear()
580        self.tcChi.SetValue(format_number(chisqr))
581        params = {}
582        is_modified = False
583        has_error = False
584        if out.__class__==numpy.float64:
585            self.param_toFit[0][1].SetValue(format_number(out))
586            self.param_toFit[0][1].Refresh()
587            if cov !=None :
588                self.text2_3.Show()
589                self.param_toFit[0][2].Show()
590                self.param_toFit[0][3].Clear()
591                self.param_toFit[0][3].SetValue(format_number(cov[0]))
592                self.param_toFit[0][3].Show()
593        #out is a list : set parameters and errors in TextCtrl
594        else:
595            i=0
596            #print "fitpage: list param  model",list
597            #for item in self.param_toFit:
598            #    print "fitpage: list display",item[0].GetLabelText()
599            for item in self.param_toFit:
600                if( out != None ) and len(out)<=len(self.param_toFit)and i < len(out):
601                    item[1].SetValue(format_number(out[i]))
602                    item[1].Refresh() 
603                if (cov !=None)and len(cov)<=len(self.param_toFit)and i < len(cov):
604                    self.text2_3.Show() 
605                    item[2].Show()
606                    item[3].Clear()
607                    item[3].SetValue(format_number(cov[i]))
608                    item[3].Show()   
609                i+=1
610       
611        self.vbox.Layout()
612        self.GrandParent.GetSizer().Layout()
613   
Note: See TracBrowser for help on using the repository browser.