source: sasview/sansview/perspectives/fitting/models.py @ 67e258c

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 67e258c was fb59ed9, checked in by Jae Cho <jhjcho@…>, 14 years ago

added new models
  • Property mode set to 100644
File size: 21.1 KB
Line 
1
2import wx
3import wx.lib.newevent
4import imp
5import os,sys,math
6import os.path
7
8(ModelEvent, EVT_MODEL) = wx.lib.newevent.NewEvent()
9from sans.guicomm.events import StatusEvent 
10# Time is needed by the log method
11import time
12
13# Explicitly import from the pluginmodel module so that py2exe
14# places it in the distribution. The Model1DPlugin class is used
15# as the base class of plug-in models.
16from sans.models.pluginmodel import Model1DPlugin
17   
18def log(message):
19    """
20    """
21    out = open("plugins.log", 'a')
22    out.write("%10g:  %s\n" % (time.clock(), message))
23    out.close()
24
25def findModels():
26    """
27    """
28    log("looking for models in: %s/plugins" % os.getcwd())
29    if os.path.isdir('plugins'):
30        return _findModels('plugins')
31    return []
32   
33def _check_plugin(model, name):
34    """
35    Do some checking before model adding plugins in the list
36   
37    :param model: class model to add into the plugin list
38    :param name:name of the module plugin
39   
40    :return model: model if valid model or None if not valid
41   
42    """
43    #Check is the plugin is of type Model1DPlugin
44    if not issubclass(model, Model1DPlugin):
45        msg= "Plugin %s must be of type Model1DPlugin \n"%str(name)
46        log(msg)
47        return None
48    if model.__name__!="Model":
49        msg= "Plugin %s class name must be Model \n"%str(name)
50        log(msg)
51        return None
52    try:
53        new_instance= model()
54    except:
55        msg="Plugin %s error in __init__ \n\t: %s %s\n"%(str(name),
56                                    str(sys.exc_type),sys.exc_value)
57        log(msg)
58        return None
59   
60    new_instance= model() 
61    if hasattr(new_instance,"function"):
62        try:
63           value=new_instance.function()
64        except:
65           msg="Plugin %s: error writing function \n\t :%s %s\n "%(str(name),
66                                    str(sys.exc_type),sys.exc_value)
67           log(msg)
68           return None
69    else:
70       msg="Plugin  %s needs a method called function \n"%str(name)
71       log(msg)
72       return None
73    return model
74 
75 
76def _findModels(dir):
77    """
78    """
79    # List of plugin objects
80    plugins = []
81    # Go through files in plug-in directory
82    try:
83        list = os.listdir(dir)
84        for item in list:
85            toks = os.path.splitext(os.path.basename(item))
86            if toks[1]=='.py' and not toks[0]=='__init__':
87                name = toks[0]
88           
89                path = [os.path.abspath(dir)]
90                file = None
91                try:
92                    (file, path, info) = imp.find_module(name, path)
93                    module = imp.load_module( name, file, item, info )
94                    if hasattr(module, "Model"):
95                        try:
96                            if _check_plugin(module.Model, name)!=None:
97                                plugins.append(module.Model)
98                        except:
99                            msg="Error accessing Model"
100                            msg+="in %s\n  %s %s\n" % (name,
101                                    str(sys.exc_type), sys.exc_value)
102                            log(msg)
103                except:
104                    msg="Error accessing Model"
105                    msg +=" in %s\n  %s %s \n" %(name,
106                                    str(sys.exc_type), sys.exc_value)
107                    log(msg)
108                finally:
109             
110                    if not file==None:
111                        file.close()
112    except:
113        # Don't deal with bad plug-in imports. Just skip.
114        pass
115    return plugins
116
117class ModelList(object):
118    """
119    Contains dictionary of model and their type
120    """
121    def __init__(self):
122        """
123        """
124        self.mydict = {}
125       
126    def set_list(self, name, mylist):
127        """
128        :param name: the type of the list
129        :param mylist: the list to add
130       
131        """
132        if name not in self.mydict.keys():
133            self.mydict[name] = mylist
134           
135           
136    def get_list(self):
137        """
138        return all the list stored in a dictionary object
139        """
140        return self.mydict
141       
142class ModelManager:
143    """
144    """
145    ## external dict for models
146    model_combobox = ModelList()
147    ## Dictionary of form models
148    form_factor_dict = {}
149    ## dictionary of other
150    struct_factor_dict = {}
151    ##list of form factors
152    shape_list =[]
153    ## independent shape model list
154    shape_indep_list = []
155    ##list of structure factors
156    struct_list= []
157    ##list of model allowing multiplication
158    multiplication_factor=[]
159    ##list of multifunctional shapes
160    multi_func_list =[]
161    ## list of added models
162    plugins=[]
163    ## Event owner (guiframe)
164    event_owner = None
165   
166    def _getModelList(self):
167        """
168        List of models we want to make available by default
169        for this application
170   
171        :return: the next free event ID following the new menu events
172       
173        """
174        from sans.models.SphereModel import SphereModel
175        self.shape_list.append(SphereModel)
176        self.multiplication_factor.append(SphereModel)
177       
178        from sans.models.SphereExpShellModel import SphereExpShellModel
179        self.shape_list.append(SphereExpShellModel)
180        self.multiplication_factor.append(SphereExpShellModel)
181        self.multi_func_list.append(SphereExpShellModel)
182       
183        from sans.models.FuzzySphereModel import FuzzySphereModel
184        self.shape_list.append(FuzzySphereModel)
185        self.multiplication_factor.append(FuzzySphereModel)
186           
187        from sans.models.CoreShellModel import CoreShellModel
188        self.shape_list.append(CoreShellModel)
189        self.multiplication_factor.append(CoreShellModel)
190       
191        from sans.models.CoreMultiShellModel import CoreMultiShellModel
192        self.shape_list.append(CoreMultiShellModel)
193        self.multiplication_factor.append(CoreMultiShellModel)
194        self.multi_func_list.append(CoreMultiShellModel)
195
196        from sans.models.VesicleModel import VesicleModel
197        self.shape_list.append(VesicleModel)
198        self.multiplication_factor.append(VesicleModel)
199       
200        from sans.models.MultiShellModel import MultiShellModel
201        self.shape_list.append(MultiShellModel)
202        self.multiplication_factor.append(MultiShellModel)
203       
204        from sans.models.BinaryHSModel import BinaryHSModel
205        self.shape_list.append(BinaryHSModel)
206       
207        from sans.models.CylinderModel import CylinderModel
208        self.shape_list.append(CylinderModel)
209        self.multiplication_factor.append(CylinderModel)
210       
211        from sans.models.CoreShellCylinderModel import CoreShellCylinderModel
212        self.shape_list.append(CoreShellCylinderModel)
213        self.multiplication_factor.append(CoreShellCylinderModel)
214       
215        from sans.models.HollowCylinderModel import HollowCylinderModel
216        self.shape_list.append(HollowCylinderModel)
217        self.multiplication_factor.append(HollowCylinderModel)
218             
219        from sans.models.FlexibleCylinderModel import FlexibleCylinderModel
220        self.shape_list.append(FlexibleCylinderModel)
221
222        from sans.models.FlexCylEllipXModel import FlexCylEllipXModel
223        self.shape_list.append(FlexCylEllipXModel)
224       
225        from sans.models.StackedDisksModel import StackedDisksModel
226        self.shape_list.append(StackedDisksModel)
227        self.multiplication_factor.append(StackedDisksModel)
228       
229        from sans.models.ParallelepipedModel import ParallelepipedModel
230        self.shape_list.append(ParallelepipedModel)
231        self.multiplication_factor.append(ParallelepipedModel)
232       
233        from sans.models.CSParallelepipedModel import CSParallelepipedModel
234        self.shape_list.append(CSParallelepipedModel)
235        self.multiplication_factor.append(CSParallelepipedModel)
236       
237        from sans.models.EllipticalCylinderModel import EllipticalCylinderModel
238        self.shape_list.append(EllipticalCylinderModel)
239        self.multiplication_factor.append(EllipticalCylinderModel)
240       
241        from sans.models.BarBellModel import BarBellModel
242        self.shape_list.append(BarBellModel)
243        # not implemeted yet!
244        #self.multiplication_factor.append(BarBellModel)
245       
246        from sans.models.CappedCylinderModel import CappedCylinderModel
247        self.shape_list.append(CappedCylinderModel)
248        # not implemeted yet!
249        #self.multiplication_factor.append(CappedCylinderModel)
250       
251        from sans.models.EllipsoidModel import EllipsoidModel
252        self.shape_list.append(EllipsoidModel)
253        self.multiplication_factor.append(EllipsoidModel)
254     
255        from sans.models.CoreShellEllipsoidModel import CoreShellEllipsoidModel
256        self.shape_list.append(CoreShellEllipsoidModel)
257        self.multiplication_factor.append(CoreShellEllipsoidModel)
258         
259        from sans.models.TriaxialEllipsoidModel import TriaxialEllipsoidModel
260        self.shape_list.append(TriaxialEllipsoidModel)
261        self.multiplication_factor.append(TriaxialEllipsoidModel)
262       
263        from sans.models.LamellarModel import LamellarModel
264        self.shape_list.append(LamellarModel)
265       
266        from sans.models.LamellarFFHGModel import LamellarFFHGModel
267        self.shape_list.append(LamellarFFHGModel)
268       
269        from sans.models.LamellarPSModel import LamellarPSModel
270        self.shape_list.append(LamellarPSModel)
271     
272        from sans.models.LamellarPSHGModel import LamellarPSHGModel
273        self.shape_list.append(LamellarPSHGModel)
274       
275        from sans.models.LamellarPCrystalModel import LamellarPCrystalModel
276        self.shape_list.append(LamellarPCrystalModel)
277       
278        from sans.models.SCCrystalModel import SCCrystalModel
279        self.shape_list.append(SCCrystalModel)
280       
281        from sans.models.FCCrystalModel import FCCrystalModel
282        self.shape_list.append(FCCrystalModel)
283       
284        from sans.models.BCCrystalModel import BCCrystalModel
285        self.shape_list.append(BCCrystalModel)
286     
287        ## Structure factor
288        from sans.models.SquareWellStructure import SquareWellStructure
289        self.struct_list.append(SquareWellStructure)
290       
291        from sans.models.HardsphereStructure import HardsphereStructure
292        self.struct_list.append(HardsphereStructure)
293         
294        from sans.models.StickyHSStructure import StickyHSStructure
295        self.struct_list.append(StickyHSStructure)
296       
297        from sans.models.HayterMSAStructure import HayterMSAStructure
298        self.struct_list.append(HayterMSAStructure)
299       
300        ##shape-independent models
301        from sans.models.PowerLawAbsModel import PowerLawAbsModel
302        self.shape_indep_list.append( PowerLawAbsModel )
303       
304        from sans.models.BEPolyelectrolyte import BEPolyelectrolyte
305        self.shape_indep_list.append(BEPolyelectrolyte )
306        self.form_factor_dict[str(wx.NewId())] =  [SphereModel]
307       
308        from sans.models.BroadPeakModel import BroadPeakModel
309        self.shape_indep_list.append(BroadPeakModel)
310       
311        from sans.models.CorrLengthModel import CorrLengthModel
312        self.shape_indep_list.append(CorrLengthModel)
313       
314        from sans.models.DABModel import DABModel
315        self.shape_indep_list.append(DABModel )
316       
317        from sans.models.DebyeModel import DebyeModel
318        self.shape_indep_list.append(DebyeModel )
319       
320        #FractalModel (a c-model)is now being used instead of FractalAbsModel.
321        from sans.models.FractalModel import FractalModel
322        self.shape_indep_list.append(FractalModel )
323       
324        from sans.models.FractalCoreShellModel import FractalCoreShellModel
325        self.shape_indep_list.append(FractalCoreShellModel )
326       
327        from sans.models.GaussLorentzGelModel import GaussLorentzGelModel
328        self.shape_indep_list.append(GaussLorentzGelModel) 
329               
330        from sans.models.GuinierModel import GuinierModel
331        self.shape_indep_list.append(GuinierModel )
332       
333        from sans.models.GuinierPorodModel import GuinierPorodModel
334        self.shape_indep_list.append(GuinierPorodModel )
335
336        from sans.models.LorentzModel import LorentzModel
337        self.shape_indep_list.append( LorentzModel) 
338       
339        from sans.models.PeakGaussModel import PeakGaussModel
340        self.shape_indep_list.append(PeakGaussModel)
341       
342        from sans.models.PeakLorentzModel import PeakLorentzModel
343        self.shape_indep_list.append(PeakLorentzModel)
344       
345        from sans.models.Poly_GaussCoil import Poly_GaussCoil
346        self.shape_indep_list.append(Poly_GaussCoil)
347       
348        from sans.models.PolymerExclVolume import PolymerExclVolume
349        self.shape_indep_list.append(PolymerExclVolume)
350       
351        from sans.models.PorodModel import PorodModel
352        self.shape_indep_list.append(PorodModel )     
353       
354        from sans.models.RPA10Model import RPA10Model
355        self.shape_indep_list.append(RPA10Model)
356        self.multi_func_list.append(RPA10Model)
357       
358        from sans.models.TeubnerStreyModel import TeubnerStreyModel
359        self.shape_indep_list.append(TeubnerStreyModel )
360       
361        from sans.models.TwoLorentzianModel import TwoLorentzianModel
362        self.shape_indep_list.append(TwoLorentzianModel )
363       
364        from sans.models.TwoPowerLawModel import TwoPowerLawModel
365        self.shape_indep_list.append(TwoPowerLawModel )
366       
367        from sans.models.UnifiedPowerRgModel import UnifiedPowerRgModel
368        self.shape_indep_list.append(UnifiedPowerRgModel )
369        self.multi_func_list.append(UnifiedPowerRgModel)
370       
371        from sans.models.LineModel import LineModel
372        self.shape_indep_list.append(LineModel)
373       
374        from sans.models.ReflectivityModel import ReflectivityModel
375        self.multi_func_list.append(ReflectivityModel)
376   
377        #Looking for plugins
378        self.plugins = findModels()
379        self._get_multifunc_models()
380        self.plugins.append(ReflectivityModel)
381        return 0
382
383   
384    def populate_menu(self, modelmenu, event_owner):
385        """
386        Populate a menu with our models
387       
388        :param id: first menu event ID to use when binding the menu events
389        :param modelmenu: wx.Menu object to populate
390        :param event_owner: wx object to bind the menu events to
391       
392        :return: the next free event ID following the new menu events
393       
394        """
395        ## Fill model lists
396        self._getModelList()
397        ## store reference to model menu of guiframe
398        self.modelmenu = modelmenu
399        ## guiframe reference
400        self.event_owner = event_owner
401       
402        shape_submenu = wx.Menu()
403        shape_indep_submenu = wx.Menu()
404        structure_factor = wx.Menu()
405        added_models = wx.Menu()
406        multip_models = wx.Menu()
407        ## create menu with shape
408        self._fill_simple_menu(menuinfo=["Shapes",shape_submenu," simple shape"],
409                         list1=self.shape_list)
410       
411        self._fill_simple_menu(menuinfo=["Shape-Independent",shape_indep_submenu,
412                                    "List of shape-independent models"],
413                         list1=self.shape_indep_list )
414       
415        self._fill_simple_menu(menuinfo=["Structure Factors",structure_factor,
416                                          "List of Structure factors models" ],
417                                list1=self.struct_list)
418       
419        self._fill_plugin_menu(menuinfo=["Customized Models", added_models,
420                                            "List of additional models"],
421                                 list1=self.plugins)
422       
423        self._fill_menu(menuinfo=["P(Q)*S(Q)",multip_models,
424                                  "mulplication of 2 models"],
425                                   list1=self.multiplication_factor ,
426                                   list2= self.struct_list)
427        return 0
428   
429    def _fill_plugin_menu(self, menuinfo, list1):
430        """
431        fill the plugin menu with costumized models
432        """
433        if len(list1)==0:
434            id = wx.NewId() 
435            msg= "No model available check plugins.log for errors to fix problem"
436            menuinfo[1].Append(int(id),"Empty",msg)
437        self._fill_simple_menu( menuinfo,list1)
438       
439    def _fill_simple_menu(self, menuinfo, list1):
440        """
441        Fill the menu with list item
442       
443        :param modelmenu: the menu to fill
444        :param menuinfo: submenu item for the first column of this modelmenu
445                         with info.Should be a list :
446                         [name(string) , menu(wx.menu), help(string)]
447        :param list1: contains item (form factor )to fill modelmenu second column
448       
449        """
450        if len(list1)>0:
451            self.model_combobox.set_list(menuinfo[0],list1)
452           
453            for item in list1:
454                try:
455                    id = wx.NewId() 
456                    struct_factor=item()
457                    struct_name = struct_factor.__class__.__name__
458                    if hasattr(struct_factor, "name"):
459                        struct_name = struct_factor.name
460                       
461                    menuinfo[1].Append(int(id),struct_name,struct_name)
462                    if not  item in self.struct_factor_dict.itervalues():
463                        self.struct_factor_dict[str(id)]= item
464                    wx.EVT_MENU(self.event_owner, int(id), self._on_model)
465                except:
466                    msg= "Error Occured: %s"%sys.exc_value
467                    wx.PostEvent(self.event_owner, StatusEvent(status=msg))
468               
469        id = wx.NewId()         
470        self.modelmenu.AppendMenu(id, menuinfo[0],menuinfo[1],menuinfo[2])
471       
472    def _fill_menu(self, menuinfo, list1, list2):
473        """
474        Fill the menu with list item
475       
476        :param menuinfo: submenu item for the first column of this modelmenu
477                         with info.Should be a list :
478                         [name(string) , menu(wx.menu), help(string)]
479        :param list1: contains item (form factor )to fill modelmenu second column
480        :param list2: contains item (Structure factor )to fill modelmenu
481                third column
482               
483        """
484        if len(list1)>0:
485            self.model_combobox.set_list(menuinfo[0],list1)
486           
487            for item in list1:   
488                form_factor= item()
489                form_name = form_factor.__class__.__name__
490                if hasattr(form_factor, "name"):
491                    form_name = form_factor.name
492                ### store form factor to return to other users   
493                newmenu= wx.Menu()
494                if len(list2)>0:
495                    for model  in list2:
496                        id = wx.NewId()
497                        struct_factor = model()
498                        name = struct_factor.__class__.__name__
499                        if hasattr(struct_factor, "name"):
500                            name = struct_factor.name
501                        newmenu.Append(id,name, name)
502                        wx.EVT_MENU(self.event_owner, int(id), self._on_model)
503                        ## save form_fact and struct_fact
504                        self.form_factor_dict[int(id)] = [form_factor,struct_factor]
505                       
506                form_id= wx.NewId()   
507                menuinfo[1].AppendMenu(int(form_id), form_name,newmenu,menuinfo[2])
508        id=wx.NewId()
509        self.modelmenu.AppendMenu(id,menuinfo[0],menuinfo[1], menuinfo[2])
510       
511    def _on_model(self, evt):
512        """
513        React to a model menu event
514       
515        :param event: wx menu event
516       
517        """
518        if int(evt.GetId()) in self.form_factor_dict.keys():
519            from sans.models.MultiplicationModel import MultiplicationModel
520            model1, model2 = self.form_factor_dict[int(evt.GetId())]
521            model = MultiplicationModel(model1, model2)   
522        else:
523            model= self.struct_factor_dict[str(evt.GetId())]()
524        evt = ModelEvent( model= model )
525        wx.PostEvent(self.event_owner, evt)
526       
527    def _get_multifunc_models(self):
528        """
529        Get the multifunctional models
530        """
531        for item in self.plugins:
532            try:
533                # check the multiplicity if any
534                if item.multiplicity_info[0] > 1:
535                    self.multi_func_list.append(item)
536            except:
537                # pass to other items
538                pass
539                   
540    def get_model_list(self):   
541        """
542        return dictionary of models for fitpanel use
543       
544        """
545        self.model_combobox.set_list("multiplication", self.multiplication_factor)
546        self.model_combobox.set_list("Multi-Functions", self.multi_func_list)
547        return self.model_combobox
548   
549 
550       
551   
552   
553 
Note: See TracBrowser for help on using the repository browser.