source: sasview/sansview/perspectives/fitting/simfitpage.py @ b770c3d

import sys,re,string, wx  
import wx.lib.newevent 
from sans.guiframe.events import StatusEvent 
from sans.guiframe.panel_base import PanelBase
from wx.lib.scrolledpanel import ScrolledPanel
#Control panel width 
if sys.platform.count("darwin")==0:
    PANEL_WID = 420
    FONT_VARIANT = 0
else:
    PANEL_WID = 490
    FONT_VARIANT = 1
            
def get_fittableParam( model):
    """
    return list of fittable parameters name of a model
    
    :param model: the model used
    
    """
    fittable_param=[]
    
    for item in model.getParamList():
        if not item  in model.getDispParamList():
            if not item in model.non_fittable:
                fittable_param.append(item)
            
    for item in model.fixed:
        fittable_param.append(item)
        
    return fittable_param

class SimultaneousFitPage(ScrolledPanel, PanelBase):
    """
    Simultaneous fitting panel
    All that needs to be defined are the
    two data members window_name and window_caption
    """
    ## Internal name for the AUI manager
    window_name = "simultaneous Fit page"
    ## Title to appear on top of the window
    window_caption = "Simultaneous Fit Page"
    
    
    def __init__(self, parent,page_finder ={}, *args, **kwargs):
        ScrolledPanel.__init__(self, parent,style= wx.FULL_REPAINT_ON_RESIZE )
        PanelBase.__init__(self, parent)
        """
        Simultaneous page display
        """
        ##Font size
        self.SetWindowVariant(variant = FONT_VARIANT)
        self.uid = None
        self.parent = parent
        ## store page_finder
        self.page_finder = page_finder
        ## list contaning info to set constraint 
        ## look like self.constraint_dict[page_id]= page 
        self.constraint_dict={}
        ## item list  self.constraints_list=[combobox1, combobox2,=,textcrtl, button ]
        self.constraints_list=[]
        ## list of current model 
        self.model_list=[]
        ## selected mdoel to fit
        self.model_toFit=[]
        ## number of constraint
        self.nb_constraint= 0
        self.uid = wx.NewId()
        ## draw page
        self.define_page_structure()
        self.draw_page()
        self.set_layout()
        
    def define_page_structure(self):
        """
        Create empty sizer for a panel
        """
        self.vbox  = wx.BoxSizer(wx.VERTICAL)
        self.sizer1 = wx.BoxSizer(wx.VERTICAL)
        self.sizer2 = wx.BoxSizer(wx.VERTICAL)
        self.sizer3 = wx.BoxSizer(wx.VERTICAL)

        self.sizer1.SetMinSize((PANEL_WID,-1))
        self.sizer2.SetMinSize((PANEL_WID,-1))
        self.sizer3.SetMinSize((PANEL_WID,-1))
        self.vbox.Add(self.sizer1)
        self.vbox.Add(self.sizer2)
        self.vbox.Add(self.sizer3)
        
    def set_scroll(self):
        """
        """
        self.SetScrollbars(20,20,25,65)
        self.Layout()  
         
    def set_layout(self):
        """
        layout
        """
        self.vbox.Layout()
        self.vbox.Fit(self) 
        self.SetSizer(self.vbox)
        self.set_scroll()
        self.Centre()
        
    def onRemove(self, event):
        """
        Remove constraint fields
        """
        if len(self.constraints_list)==1:
            self.hide_constraint.SetValue(True)
            self._hide_constraint()
            return 
        if len(self.constraints_list)==0:
            return 
        for item in self.constraints_list:
            length= len(item)
            if event.GetId()==item[length-2].GetId():
                sizer= item[length-1]
                sizer.Clear(True)
                self.sizer_constraints.Remove(sizer)
              
                self.sizer2.Layout()
                self.SetScrollbars(20,20,25,65)
                self.constraints_list.remove(item)
                self.nb_constraint -= 1
                break
                
    def onFit(self,event):
        """
        signal for fitting
        
        """
        ## making sure all parameters content a constraint
        ## validity of the constraint expression is own by fit engine
        if self.show_constraint.GetValue():
            self._set_constraint()
        ## get the fit range of very fit problem        
        for id, value in self.page_finder.iteritems():
            qmin, qmax= self.page_finder[id].get_range()
            value.set_range(qmin, qmax)
        ## model was actually selected from this page to be fit
        if len(self.model_toFit) >= 1 :
            self.manager._reset_schedule_problem(value=0)
            for item in self.model_list:
                if item[0].GetValue():
                    self.manager.schedule_for_fit( value=1, fitproblem =item[1]) 
            self.manager.onFit(None)
        else:
            msg= "Select at least one model to fit "
            wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
           
    def set_manager(self, manager):
        """
        set panel manager
        
        :param manager: instance of plugin fitting
        
        """
        self.manager = manager
       
    def check_all_model_name(self,event):
        """
        check all models names
        """
        self.model_toFit = [] 
        if self.cb1.GetValue()== True:
            for item in self.model_list:
                item[0].SetValue(True)
                self.model_toFit.append(item)
                
            ## constraint info
            self._store_model()
            ## display constraint fields
            if self.show_constraint.GetValue():
                self._show_constraint()
                return
        else:
            for item in self.model_list:
                item[0].SetValue(False) 
                
            self.model_toFit=[]
            ##constraint info
            self._hide_constraint()
        
    def check_model_name(self,event):
        """
        Save information related to checkbox and their states
        """
        self.model_toFit=[]
        for item in self.model_list:
            if item[0].GetValue()==True:
                self.model_toFit.append(item)
            else:
                if item in self.model_toFit:
                    self.model_toFit.remove(item)
                    self.cb1.SetValue(False)
        
        ## display constraint fields
        if len(self.model_toFit)==2:
            self._store_model()
            if self.show_constraint.GetValue() and len(self.constraints_list)==0:
                self._show_constraint()
        elif len(self.model_toFit)< 2:
            ##constraint info
            self._hide_constraint()              
       
        ## set the value of the main check button          
        if len(self.model_list)==len(self.model_toFit):
            self.cb1.SetValue(True)
            return
        else:
            self.cb1.SetValue(False)
        
    def draw_page(self):      
        """
        Draw a sizer containing couples of data and model 
        """ 
        self.model_list=[]
        self.model_toFit=[]
        self.constraints_list=[]
        self.constraint_dict={}
        self.nb_constraint= 0
        
        if len(self.model_list)>0:
            for item in self.model_list:
                item[0].SetValue(False) 
                self.manager.schedule_for_fit( value=0,fitproblem =item[1])
                
        self.sizer1.Clear(True)    
        box_description= wx.StaticBox(self, -1,"Fit Combinations")
        boxsizer1 = wx.StaticBoxSizer(box_description, wx.VERTICAL)
        sizer_title = wx.BoxSizer(wx.HORIZONTAL)
        sizer_couples = wx.GridBagSizer(5,5)
        #------------------------------------------------------
        if len(self.page_finder)==0:
            msg = " No fit combinations are found! \n\n"
            msg += " Please load data and set up at least two fit panels first..."
            sizer_title.Add(wx.StaticText(self, -1, msg))
        else:
            ## store model  
            self._store_model()
        
            self.cb1 = wx.CheckBox(self, -1,'Select all')
            self.cb1.SetValue(False)
            wx.EVT_CHECKBOX(self, self.cb1.GetId(), self.check_all_model_name)
            
            sizer_title.Add((10,10),0,
                wx.TOP|wx.BOTTOM|wx.EXPAND|wx.ADJUST_MINSIZE,border=5)
            sizer_title.Add(self.cb1,0,
                wx.TOP|wx.BOTTOM|wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE,border=5)
            
            ## draw list of model and data name
            self._fill_sizer_model_list(sizer_couples)
            ## draw the sizer containing constraint info
            self._fill_sizer_constraint()
            ## draw fit button 
            self._fill_sizer_fit()
        #--------------------------------------------------------
        boxsizer1.Add(sizer_title, flag= wx.TOP|wx.BOTTOM,border=5) 
        boxsizer1.Add(sizer_couples, flag= wx.TOP|wx.BOTTOM,border=5)
       
        self.sizer1.Add(boxsizer1,1, wx.EXPAND | wx.ALL, 10)
        self.sizer1.Layout()
        self.SetScrollbars(20,20,25,65)
        self.AdjustScrollbars()
        
    def _store_model(self):
        """
         Store selected model
        """
        if len(self.model_toFit) < 2:
            return
        for item in self.model_toFit:
            model = item[3]
            page_id= item[2]
            self.constraint_dict[page_id] = model
                   
    def _display_constraint(self, event):
        """
        Show fields to add constraint
        """
        if len(self.model_toFit)< 2:
            msg= "Select at least 2 models to add constraint "
            wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
            ## hide button
            self._hide_constraint()
            return
        if self.show_constraint.GetValue():
            self._show_constraint()
            return
        else:
           self._hide_constraint()
           return 
            
    def _show_constraint(self):
        """
        Show constraint fields
        """
        self.btAdd.Show(True)
        if len(self.constraints_list)!= 0:
            nb_fit_param = 0
            for model in self.constraint_dict.values():
                nb_fit_param += len(get_fittableParam(model))
            ##Don't add anymore
            if len(self.constraints_list) == nb_fit_param:
                msg= "Cannot add another constraint .Maximum of number "
                msg += "Parameters name reached %s"%str(nb_fit_param)
                wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
                self.sizer_constraints.Layout()
                self.sizer2.Layout()
                self.SetScrollbars(20,20,25,65)
                return
            
        if len(self.model_toFit) < 2 :
            msg= "Select at least 2 model to add constraint "
            wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
            self.sizer_constraints.Layout()
            self.sizer2.Layout()
            self.SetScrollbars(20,20,25,65)
            return
            
        sizer_constraint =  wx.BoxSizer(wx.HORIZONTAL)
        model_cbox = wx.ComboBox(self, -1,style=wx.CB_READONLY)
        model_cbox.Clear()
        param_cbox = wx.ComboBox(self, -1,style=wx.CB_READONLY)
        param_cbox.Hide()
        
        #This is for GetCLientData() _on_select_param: Was None return on MAC.
        self.param_cbox = param_cbox
        
        wx.EVT_COMBOBOX(param_cbox,-1, self._on_select_param)
        ctl2 = wx.TextCtrl(self, -1)
        egal_txt= wx.StaticText(self,-1," = ")
        btRemove = wx.Button(self,wx.NewId(),'Remove')
        btRemove.Bind(wx.EVT_BUTTON, self.onRemove,id= btRemove.GetId())
        btRemove.SetToolTipString("Remove constraint.")
       
        for id,model in self.constraint_dict.iteritems():
            ## check if all parameters have been selected for constraint
            ## then do not allow add constraint on parameters
            model_cbox.Append( str(model.name), model)
            
        #This is for GetCLientData() passing to self._on_select_param: Was None return on MAC.
        self.model_cbox = model_cbox
           
        wx.EVT_COMBOBOX(model_cbox,-1, self._on_select_model)
    
        sizer_constraint.Add(model_cbox, flag= wx.RIGHT|wx.EXPAND,border=10)
        sizer_constraint.Add(param_cbox, flag= wx.RIGHT|wx.EXPAND,border=5)
        sizer_constraint.Add(egal_txt, flag= wx.RIGHT|wx.EXPAND,border=5)
        sizer_constraint.Add(ctl2, flag= wx.RIGHT|wx.EXPAND,border=10)
        sizer_constraint.Add(btRemove, flag= wx.RIGHT|wx.EXPAND,border=10)
      
        self.sizer_constraints.Insert(before=self.nb_constraint,
                                      item=sizer_constraint, flag= wx.TOP|wx.BOTTOM|wx.EXPAND,
                                   border=5)
        ##[combobox1, combobox2,=,textcrtl, remove button ]
        self.constraints_list.append([model_cbox, param_cbox, egal_txt, ctl2,btRemove,sizer_constraint])
    
        self.nb_constraint += 1
        self.sizer_constraints.Layout()
        self.sizer2.Layout()
        self.SetScrollbars(20,20,25,65)
        
    def _hide_constraint(self): 
        """
        hide buttons related constraint 
        """  
        for id in  self.page_finder.iterkeys():
            self.page_finder[id].clear_model_param()
               
        self.nb_constraint =0     
        self.constraint_dict={}
        if hasattr(self,"btAdd"):
            self.btAdd.Hide()
        self._store_model()
        self.constraints_list=[]         
        self.sizer_constraints.Clear(True) 
        self.sizer_constraints.Layout()    
        self.sizer2.Layout()
        self.SetScrollbars(20,20,25,65)
        self.AdjustScrollbars()    
            
    def _on_select_model(self, event):
        """
        fill combox box with list of parameters
        """
        ##This way PC/MAC both work, instead of using event.GetClientData().
        n = self.model_cbox.GetCurrentSelection()
        model = self.model_cbox.GetClientData(n)
        
        param_list= get_fittableParam(model)
        length = len(self.constraints_list)
        if length < 1:
            return 
        param_cbox = self.constraints_list[length-1][1]
        param_cbox.Clear()
        ## insert only fittable paramaters
        for param in param_list:
            param_cbox.Append( str(param), model)
            
        param_cbox.Show(True)
        self.sizer2.Layout()
        self.SetScrollbars(20,20,25,65)
        
    def _on_select_param(self, event):
        """
        Store the appropriate constraint in the page_finder
        """
        ##This way PC/MAC both work, instead of using event.GetClientData().
        n = self.param_cbox.GetCurrentSelection()
        model = self.param_cbox.GetClientData(n)
        param = event.GetString()
      
        length = len(self.constraints_list)
        if length < 1:
            return 
        egal_txt = self.constraints_list[length-1][2]
        egal_txt.Show(True)       
        
        ctl2 = self.constraints_list[length-1][3]
        ctl2.Show(True)
        #self.sizer2.Layout()
        self.SetScrollbars(20,20,25,65)
        
    def _onAdd_constraint(self, event):  
        """
        Add another line for constraint
        """
        if not self.show_constraint.GetValue():
            msg= " Select Yes to add Constraint "
            wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
            return 
        ## check that a constraint is added before allow to add another cosntraint
        for item in self.constraints_list:
            model_cbox = item[0]
            if model_cbox.GetString(0)=="":
                msg= " Select a model Name! "
                wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
                return 
            param_cbox = item[1]
            if param_cbox.GetString(0)=="":
                msg= " Select a parameter Name! "
                wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
                return 
            ctl2 = item[3]
            if ctl2.GetValue().lstrip().rstrip()=="":
                model= param_cbox.GetClientData(param_cbox.GetCurrentSelection())
                msg= " Enter a constraint for %s.%s! "%(model.name,param_cbox.GetString(0))           
                wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
                return 
        ## some model or parameters can be constrained
        self._show_constraint()
        
    def _fill_sizer_fit(self):
        """
        Draw fit button
        """
        self.sizer3.Clear(True)
        box_description= wx.StaticBox(self, -1,"Fit ")
        boxsizer1 = wx.StaticBoxSizer(box_description, wx.VERTICAL)
        sizer_button = wx.BoxSizer(wx.HORIZONTAL)
          
        self.btFit = wx.Button(self,wx.NewId(),'Fit')
        self.btFit.Bind(wx.EVT_BUTTON, self.onFit,id= self.btFit.GetId())
        self.btFit.SetToolTipString("Perform fit.")
        
        text= "Hint: Park fitting engine will be selected \n"
        text+= "automatically for more than 2 combinations checked"
        text_hint = wx.StaticText(self,-1,text)
        
        sizer_button.Add(text_hint,  wx.RIGHT|wx.EXPAND, 10)
        sizer_button.Add(self.btFit, 0, wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 10)
        
        boxsizer1.Add(sizer_button, flag= wx.TOP|wx.BOTTOM,border=10)
        self.sizer3.Add(boxsizer1,0, wx.EXPAND | wx.ALL, 10)
        self.sizer3.Layout()
        self.SetScrollbars(20,20,25,65)
        
    def _fill_sizer_constraint(self):
        """
        Fill sizer containing constraint info
        """
        msg = "Select at least 2 model to add constraint "
        wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
        
        self.sizer2.Clear(True)
        box_description= wx.StaticBox(self, -1,"Fit Constraints")
        boxsizer1 = wx.StaticBoxSizer(box_description, wx.VERTICAL)
        sizer_title = wx.BoxSizer(wx.HORIZONTAL)
        self.sizer_constraints = wx.BoxSizer(wx.VERTICAL)
        sizer_button = wx.BoxSizer(wx.HORIZONTAL)
        
        self.hide_constraint = wx.RadioButton(self, -1, 'No', (10, 10), style=wx.RB_GROUP)
        self.show_constraint = wx.RadioButton(self, -1, 'Yes', (10, 30))
        self.Bind( wx.EVT_RADIOBUTTON, self._display_constraint,
                    id= self.hide_constraint.GetId() )
        self.Bind(  wx.EVT_RADIOBUTTON, self._display_constraint,
                         id= self.show_constraint.GetId()    )
        self.hide_constraint.SetValue(True)
        sizer_title.Add( wx.StaticText(self,-1," Model") )
        sizer_title.Add(( 10,10) )
        sizer_title.Add( wx.StaticText(self,-1," Parameter") )
        sizer_title.Add(( 10,10) )
        sizer_title.Add( wx.StaticText(self,-1," Add Constraint?") )
        sizer_title.Add(( 10,10) )
        sizer_title.Add( self.show_constraint )
        sizer_title.Add( self.hide_constraint )
        sizer_title.Add(( 10,10) )
       
        self.btAdd =wx.Button(self,wx.NewId(),'Add')
        self.btAdd.Bind(wx.EVT_BUTTON, self._onAdd_constraint,id= self.btAdd.GetId())
        self.btAdd.SetToolTipString("Add another constraint?")
        self.btAdd.Hide()
     
        text_hint = wx.StaticText(self,-1,"Example: [M0][paramter] = M1.parameter") 
        sizer_button.Add(text_hint, 0 , wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 10)
        sizer_button.Add(self.btAdd, 0, wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 10)
       
        boxsizer1.Add(sizer_title, flag= wx.TOP|wx.BOTTOM,border=10)
        boxsizer1.Add(self.sizer_constraints, flag= wx.TOP|wx.BOTTOM,border=10)
        boxsizer1.Add(sizer_button, flag= wx.TOP|wx.BOTTOM,border=10)
        
        self.sizer2.Add(boxsizer1,0, wx.EXPAND | wx.ALL, 10)
        self.sizer2.Layout()
        self.SetScrollbars(20,20,25,65)
    
    def _set_constraint(self):
        """
        get values from the constrainst textcrtl ,parses them into model name
        parameter name and parameters values.
        store them in a list self.params .when when params is not empty set_model 
        uses it to reset the appropriate model and its appropriates parameters
        """
        for item in self.constraints_list:
            model = item[0].GetClientData(item[0].GetCurrentSelection())
            param = item[1].GetString(item[1].GetCurrentSelection())
            constraint = item[3].GetValue().lstrip().rstrip()
            if param.lstrip().rstrip()=="":
                param= None
                msg= " Constraint will be ignored!. missing parameters in combobox"
                msg+= " to set constraint! "
                wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
            for id, value in self.constraint_dict.iteritems():
                if model == value:
                    if constraint == "":
                        msg= " Constraint will be ignored!. missing value in textcrtl"
                        msg+= " to set constraint! "
                        wx.PostEvent(self.parent.Parent, StatusEvent(status= msg ))
                        constraint = None
                    self.page_finder[id].set_model_param(param,constraint)
                    break
    
    def _fill_sizer_model_list(self,sizer):
        """
        Receive a dictionary containing information to display model name
        
        :param page_finder: the dictionary containing models information
        
        """
        ix = 0
        iy = 0
        list=[]
        sizer.Clear(True)
        
        new_name = wx.StaticText(self, -1, 'New Model Name', style=wx.ALIGN_CENTER)
        new_name.SetBackgroundColour('orange')
        sizer.Add(new_name,(iy, ix),(1,1),
                            wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 15)
        ix += 2 
        model_type = wx.StaticText(self, -1, '  Model Type')
        model_type.SetBackgroundColour('grey')
        sizer.Add(model_type,(iy, ix),(1,1),
                            wx.EXPAND|wx.ADJUST_MINSIZE, 0) 
        ix += 1 
        data_used = wx.StaticText(self, -1, '  Used Data')
        data_used.SetBackgroundColour('grey')
        sizer.Add(data_used,(iy, ix),(1,1),
                            wx.EXPAND|wx.ADJUST_MINSIZE, 0) 
        ix += 1 
        tab_used = wx.StaticText(self, -1, '  Fit Tab')
        tab_used.SetBackgroundColour('grey')
        sizer.Add(tab_used,(iy, ix),(1,1),
                            wx.EXPAND|wx.ADJUST_MINSIZE, 0) 
        for id, value in self.page_finder.iteritems():
            try:
                ix = 0
                iy += 1 
                model = value.get_model()
                name = '_'
                if model is not None:
                    name = str(model.name)
                cb = wx.CheckBox(self, -1, name)
                cb.SetValue(False)
                cb.Enable(model is not None)
                sizer.Add( cb,( iy,ix),(1,1),  wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 15)
                wx.EVT_CHECKBOX(self, cb.GetId(), self.check_model_name)
                ix += 2 
                type = model.__class__.__name__
                model_type = wx.StaticText(self, -1, str(type))
                sizer.Add(model_type,( iy,ix),(1,1),  wx.EXPAND|wx.ADJUST_MINSIZE, 0)
                data = value.get_fit_data()
                name = '-'
                if data is not None:
                    name = str(data.name)
                data_used = wx.StaticText(self, -1, name)
                ix += 1 
                sizer.Add(data_used,( iy,ix),(1,1),  wx.EXPAND|wx.ADJUST_MINSIZE, 0)
                    
                ix += 1 
                caption = value.get_fit_tab_caption()
                tab_caption_used= wx.StaticText(self, -1, str(caption))
                sizer.Add(tab_caption_used,( iy,ix),(1,1),  wx.EXPAND|wx.ADJUST_MINSIZE, 0)
                
                self.model_list.append([cb,value,id,model])
                
            except:
                raise
                #pass
        iy += 1
        sizer.Add((20,20),( iy,ix),(1,1),  wx.LEFT|wx.EXPAND|wx.ADJUST_MINSIZE, 15)
        sizer.Layout()