-                      rce07fa8
+                      r5062bbf
-#TODO: add comments to document this module
-#TODO: clean-up the exception handling.
-#TODO: clean-up the FractalAbsModel and PowerLawAbsModel menu items. Those
-#      model definitions do not belong here. They belong with the rest of the
-#      models.
 import wx
 …
 def log(message):
+    """
+    """
     out = open("plugins.log", 'a')
     out.write("%10g:  %s\n" % (time.clock(), message))
 …
 def findModels():
+    """
+    """
     log("looking for models in: %s/plugins" % os.getcwd())
     if os.path.isdir('plugins'):
 …
 def _check_plugin(model, name):
     """
+        Do some checking before model adding plugins in the list
+        @param model: class model to add into the plugin list
+        @param name:name of the module plugin
+        @return model: model if valid model or None if not valid
+    Do some checking before model adding plugins in the list
+    :param model: class model to add into the plugin list
+    :param name:name of the module plugin
+    :return model: model if valid model or None if not valid
     """
     #Check is the plugin is of type Model1DPlugin
 …
 def _findModels(dir):
+    """
+    """
     # List of plugin objects
     plugins = []
 …
 class ModelList(object):
     """
         Contains dictionary of model and their type
+    Contains dictionary of model and their type
     """
     def __init__(self):
+        self.mydict={}
+        """
+        """
+        self.mydict = {}
     def set_list(self, name, mylist):
         """
+            @param name: the type of the list
+            @param mylist: the list to add
+        :param name: the type of the list
+        :param mylist: the list to add
         """
         if name not in self.mydict.keys():
 …
     def get_list(self):
         """
          return all the list stored in a dictionary object
+        return all the list stored in a dictionary object
         """
         return self.mydict
 class ModelManager:
+    """
+    """
     ## external dict for models
     model_combobox = ModelList()
 …
     def _getModelList(self):
         """
+            List of models we want to make available by default
+            for this application
+            @return: the next free event ID following the new menu events
+        List of models we want to make available by default
+        for this application
+        :return: the next free event ID following the new menu events
         """
         ## form factor
 …
         from sans.models.HayterMSAStructure import HayterMSAStructure
         self.struct_list.append(HayterMSAStructure)
+        ##shape-independent models
+        ##shape-independent models
         from sans.models.PowerLawAbsModel import PowerLawAbsModel
         self.shape_indep_list.append( PowerLawAbsModel )
 …
         self.shape_indep_list.append(PorodModel )
         #FractalModel (a c-model)will be used.
         #from sans.models.FractalAbsModel import FractalAbsModel
 …
         from sans.models.LineModel import LineModel
         self.shape_indep_list.append(LineModel)
         #Looking for plugins
         self.plugins = findModels()
         return 0
 …
     def populate_menu(self, modelmenu, event_owner):
         """
+            Populate a menu with our models
+            @param id: first menu event ID to use when binding the menu events
+            @param modelmenu: wx.Menu object to populate
+            @param event_owner: wx object to bind the menu events to
+            @return: the next free event ID following the new menu events
+        Populate a menu with our models
+        :param id: first menu event ID to use when binding the menu events
+        :param modelmenu: wx.Menu object to populate
+        :param event_owner: wx object to bind the menu events to
+        :return: the next free event ID following the new menu events
         """
         ## Fill model lists
 …
         self.event_owner = event_owner
         shape_submenu = wx.Menu()
         shape_indep_submenu = wx.Menu()
 …
         multip_models = wx.Menu()
         ## create menu with shape
         self._fill_simple_menu( menuinfo = ["Shapes",shape_submenu," simple shape"],
                          list1 = self.shape_list )
         self._fill_simple_menu( menuinfo = ["Shape-Independent",shape_indep_submenu,
+        self._fill_simple_menu(menuinfo=["Shapes",shape_submenu," simple shape"],
+                         list1=self.shape_list)
+        self._fill_simple_menu(menuinfo=["Shape-Independent",shape_indep_submenu,
                                     "List of shape-independent models"],
                          list1 = self.shape_indep_list )
         self._fill_simple_menu( menuinfo= ["Structure Factors",structure_factor,
+                         list1=self.shape_indep_list )
+        self._fill_simple_menu(menuinfo=["Structure Factors",structure_factor,
                                           "List of Structure factors models" ],
                                 list1= self.struct_list )
         self._fill_plugin_menu( menuinfo = ["Customized Models", added_models,
+                                list1=self.struct_list)
+        self._fill_plugin_menu(menuinfo=["Customized Models", added_models,
                                             "List of additional models"],
                                  list1= self.plugins )
+                                 list1=self.plugins)
         self._fill_menu(menuinfo=["P(Q)*S(Q)",multip_models,
                                   "mulplication of 2 models"],
+                                   list1 = self.multiplication_factor ,
+                                   list2 =  self.struct_list)
+                                   list1=self.multiplication_factor ,
+                                   list2= self.struct_list)
         return 0
     def _fill_plugin_menu(self,menuinfo, list1):
         """
             fill the plugin menu with costumized models
+    def _fill_plugin_menu(self, menuinfo, list1):
+        """
+        fill the plugin menu with costumized models
         """
         if len(list1)==0:
 …
         self._fill_simple_menu( menuinfo,list1)
+    def _fill_simple_menu(self,menuinfo, list1):
+        """
+            Fill the menu with list item
+            @param modelmenu: the menu to fill
+            @param menuinfo: submenu item for the first column of this modelmenu
+                             with info.Should be a list :
+                             [name(string) , menu(wx.menu), help(string)]
+            @param list1: contains item (form factor )to fill modelmenu second column
+    def _fill_simple_menu(self, menuinfo, list1):
+        """
+        Fill the menu with list item
+        :param modelmenu: the menu to fill
+        :param menuinfo: submenu item for the first column of this modelmenu
+                         with info.Should be a list :
+                         [name(string) , menu(wx.menu), help(string)]
+        :param list1: contains item (form factor )to fill modelmenu second column
         """
         if len(list1)>0:
 …
         self.modelmenu.AppendMenu(id, menuinfo[0],menuinfo[1],menuinfo[2])
+    def _fill_menu(self,menuinfo, list1,list2  ):
+        """
+            Fill the menu with list item
+            @param menuinfo: submenu item for the first column of this modelmenu
+                             with info.Should be a list :
+                             [name(string) , menu(wx.menu), help(string)]
+            @param list1: contains item (form factor )to fill modelmenu second column
+            @param list2: contains item (Structure factor )to fill modelmenu third column
+    def _fill_menu(self, menuinfo, list1, list2):
+        """
+        Fill the menu with list item
+        :param menuinfo: submenu item for the first column of this modelmenu
+                         with info.Should be a list :
+                         [name(string) , menu(wx.menu), help(string)]
+        :param list1: contains item (form factor )to fill modelmenu second column
+        :param list2: contains item (Structure factor )to fill modelmenu
+                third column
         """
         if len(list1)>0:
 …
         self.modelmenu.AppendMenu(id,menuinfo[0],menuinfo[1], menuinfo[2])
     def _on_model(self, evt):
         """
+            React to a model menu event
+            @param event: wx menu event
+        React to a model menu event
+        :param event: wx menu event
         """
         if int(evt.GetId()) in self.form_factor_dict.keys():
             from sans.models.MultiplicationModel import MultiplicationModel
             model1, model2 = self.form_factor_dict[int(evt.GetId())]
+            model = MultiplicationModel(model1, model2)
+            model = MultiplicationModel(model1, model2)
         else:
             model= self.struct_factor_dict[str(evt.GetId())]()
         evt = ModelEvent( model= model )
         wx.PostEvent(self.event_owner, evt)
     def get_model_list(self):
+        """ @ return dictionary of models for fitpanel use """
+        """
+        return dictionary of models for fitpanel use
+        """
         self.model_combobox.set_list("multiplication", self.multiplication_factor)
         return self.model_combobox

Note: See TracChangeset for help on using the changeset viewer.

SasView

Changeset 5062bbf in sasview for sansview/perspectives/fitting/models.py

Legend:

sansview/perspectives/fitting/models.py

Download in other formats: