source: sasview/sansview/perspectives/fitting/models.py @ e2f0554

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 e2f0554 was 6bbeacd4, checked in by Gervaise Alina <gervyh@…>, 14 years ago

remove other type of data
  • Property mode set to 100644
File size: 22.0 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.guiframe.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    def __init__(self):
166        """
167        """
168        self._getModelList()
169       
170    def _getModelList(self):
171        """
172        List of models we want to make available by default
173        for this application
174   
175        :return: the next free event ID following the new menu events
176       
177        """
178        from sans.models.SphereModel import SphereModel
179        self.shape_list.append(SphereModel)
180        self.multiplication_factor.append(SphereModel)
181       
182        from sans.models.BinaryHSModel import BinaryHSModel
183        self.shape_list.append(BinaryHSModel)
184                       
185        from sans.models.FuzzySphereModel import FuzzySphereModel
186        self.shape_list.append(FuzzySphereModel)
187        self.multiplication_factor.append(FuzzySphereModel)
188           
189        from sans.models.CoreShellModel import CoreShellModel
190        self.shape_list.append(CoreShellModel)
191        self.multiplication_factor.append(CoreShellModel)
192       
193        from sans.models.CoreMultiShellModel import CoreMultiShellModel
194        self.shape_list.append(CoreMultiShellModel)
195        self.multiplication_factor.append(CoreMultiShellModel)
196        self.multi_func_list.append(CoreMultiShellModel)
197
198        from sans.models.VesicleModel import VesicleModel
199        self.shape_list.append(VesicleModel)
200        self.multiplication_factor.append(VesicleModel)
201       
202        from sans.models.MultiShellModel import MultiShellModel
203        self.shape_list.append(MultiShellModel)
204        self.multiplication_factor.append(MultiShellModel)
205       
206        from sans.models.OnionExpShellModel import OnionExpShellModel
207        self.shape_list.append(OnionExpShellModel)
208        self.multiplication_factor.append(OnionExpShellModel)
209        self.multi_func_list.append(OnionExpShellModel)
210                       
211        from sans.models.SphericalSLDModel import SphericalSLDModel
212        self.shape_list.append(SphericalSLDModel)
213        self.multiplication_factor.append(SphericalSLDModel)
214        self.multi_func_list.append(SphericalSLDModel)
215       
216        from sans.models.CylinderModel import CylinderModel
217        self.shape_list.append(CylinderModel)
218        self.multiplication_factor.append(CylinderModel)
219       
220        from sans.models.CoreShellCylinderModel import CoreShellCylinderModel
221        self.shape_list.append(CoreShellCylinderModel)
222        self.multiplication_factor.append(CoreShellCylinderModel)
223       
224        from sans.models.HollowCylinderModel import HollowCylinderModel
225        self.shape_list.append(HollowCylinderModel)
226        self.multiplication_factor.append(HollowCylinderModel)
227             
228        from sans.models.FlexibleCylinderModel import FlexibleCylinderModel
229        self.shape_list.append(FlexibleCylinderModel)
230
231        from sans.models.FlexCylEllipXModel import FlexCylEllipXModel
232        self.shape_list.append(FlexCylEllipXModel)
233       
234        from sans.models.StackedDisksModel import StackedDisksModel
235        self.shape_list.append(StackedDisksModel)
236        self.multiplication_factor.append(StackedDisksModel)
237       
238        from sans.models.ParallelepipedModel import ParallelepipedModel
239        self.shape_list.append(ParallelepipedModel)
240        self.multiplication_factor.append(ParallelepipedModel)
241       
242        from sans.models.CSParallelepipedModel import CSParallelepipedModel
243        self.shape_list.append(CSParallelepipedModel)
244        self.multiplication_factor.append(CSParallelepipedModel)
245       
246        from sans.models.EllipticalCylinderModel import EllipticalCylinderModel
247        self.shape_list.append(EllipticalCylinderModel)
248        self.multiplication_factor.append(EllipticalCylinderModel)
249       
250        from sans.models.BarBellModel import BarBellModel
251        self.shape_list.append(BarBellModel)
252        # not implemeted yet!
253        #self.multiplication_factor.append(BarBellModel)
254       
255        from sans.models.CappedCylinderModel import CappedCylinderModel
256        self.shape_list.append(CappedCylinderModel)
257        # not implemeted yet!
258        #self.multiplication_factor.append(CappedCylinderModel)
259       
260        from sans.models.EllipsoidModel import EllipsoidModel
261        self.shape_list.append(EllipsoidModel)
262        self.multiplication_factor.append(EllipsoidModel)
263     
264        from sans.models.CoreShellEllipsoidModel import CoreShellEllipsoidModel
265        self.shape_list.append(CoreShellEllipsoidModel)
266        self.multiplication_factor.append(CoreShellEllipsoidModel)
267         
268        from sans.models.TriaxialEllipsoidModel import TriaxialEllipsoidModel
269        self.shape_list.append(TriaxialEllipsoidModel)
270        self.multiplication_factor.append(TriaxialEllipsoidModel)
271       
272        from sans.models.LamellarModel import LamellarModel
273        self.shape_list.append(LamellarModel)
274       
275        from sans.models.LamellarFFHGModel import LamellarFFHGModel
276        self.shape_list.append(LamellarFFHGModel)
277       
278        from sans.models.LamellarPSModel import LamellarPSModel
279        self.shape_list.append(LamellarPSModel)
280     
281        from sans.models.LamellarPSHGModel import LamellarPSHGModel
282        self.shape_list.append(LamellarPSHGModel)
283       
284        from sans.models.LamellarPCrystalModel import LamellarPCrystalModel
285        self.shape_list.append(LamellarPCrystalModel)
286       
287        from sans.models.SCCrystalModel import SCCrystalModel
288        self.shape_list.append(SCCrystalModel)
289       
290        from sans.models.FCCrystalModel import FCCrystalModel
291        self.shape_list.append(FCCrystalModel)
292       
293        from sans.models.BCCrystalModel import BCCrystalModel
294        self.shape_list.append(BCCrystalModel)
295     
296        ## Structure factor
297        from sans.models.SquareWellStructure import SquareWellStructure
298        self.struct_list.append(SquareWellStructure)
299       
300        from sans.models.HardsphereStructure import HardsphereStructure
301        self.struct_list.append(HardsphereStructure)
302         
303        from sans.models.StickyHSStructure import StickyHSStructure
304        self.struct_list.append(StickyHSStructure)
305       
306        from sans.models.HayterMSAStructure import HayterMSAStructure
307        self.struct_list.append(HayterMSAStructure)
308       
309        ##shape-independent models
310        from sans.models.PowerLawAbsModel import PowerLawAbsModel
311        self.shape_indep_list.append( PowerLawAbsModel )
312       
313        from sans.models.BEPolyelectrolyte import BEPolyelectrolyte
314        self.shape_indep_list.append(BEPolyelectrolyte )
315        self.form_factor_dict[str(wx.NewId())] =  [SphereModel]
316       
317        from sans.models.BroadPeakModel import BroadPeakModel
318        self.shape_indep_list.append(BroadPeakModel)
319       
320        from sans.models.CorrLengthModel import CorrLengthModel
321        self.shape_indep_list.append(CorrLengthModel)
322       
323        from sans.models.DABModel import DABModel
324        self.shape_indep_list.append(DABModel )
325       
326        from sans.models.DebyeModel import DebyeModel
327        self.shape_indep_list.append(DebyeModel )
328       
329        #FractalModel (a c-model)is now being used instead of FractalAbsModel.
330        from sans.models.FractalModel import FractalModel
331        self.shape_indep_list.append(FractalModel )
332       
333        from sans.models.FractalCoreShellModel import FractalCoreShellModel
334        self.shape_indep_list.append(FractalCoreShellModel )
335       
336        from sans.models.GaussLorentzGelModel import GaussLorentzGelModel
337        self.shape_indep_list.append(GaussLorentzGelModel) 
338               
339        from sans.models.GuinierModel import GuinierModel
340        self.shape_indep_list.append(GuinierModel )
341       
342        from sans.models.GuinierPorodModel import GuinierPorodModel
343        self.shape_indep_list.append(GuinierPorodModel )
344
345        from sans.models.LorentzModel import LorentzModel
346        self.shape_indep_list.append( LorentzModel) 
347       
348        from sans.models.PeakGaussModel import PeakGaussModel
349        self.shape_indep_list.append(PeakGaussModel)
350       
351        from sans.models.PeakLorentzModel import PeakLorentzModel
352        self.shape_indep_list.append(PeakLorentzModel)
353       
354        from sans.models.Poly_GaussCoil import Poly_GaussCoil
355        self.shape_indep_list.append(Poly_GaussCoil)
356       
357        from sans.models.PolymerExclVolume import PolymerExclVolume
358        self.shape_indep_list.append(PolymerExclVolume)
359       
360        from sans.models.PorodModel import PorodModel
361        self.shape_indep_list.append(PorodModel )     
362       
363        from sans.models.RPA10Model import RPA10Model
364        self.shape_indep_list.append(RPA10Model)
365        self.multi_func_list.append(RPA10Model)
366       
367        from sans.models.TeubnerStreyModel import TeubnerStreyModel
368        self.shape_indep_list.append(TeubnerStreyModel )
369       
370        from sans.models.TwoLorentzianModel import TwoLorentzianModel
371        self.shape_indep_list.append(TwoLorentzianModel )
372       
373        from sans.models.TwoPowerLawModel import TwoPowerLawModel
374        self.shape_indep_list.append(TwoPowerLawModel )
375       
376        from sans.models.UnifiedPowerRgModel import UnifiedPowerRgModel
377        self.shape_indep_list.append(UnifiedPowerRgModel )
378        self.multi_func_list.append(UnifiedPowerRgModel)
379       
380        from sans.models.LineModel import LineModel
381        self.shape_indep_list.append(LineModel)
382       
383        from sans.models.ReflectivityModel import ReflectivityModel
384        self.multi_func_list.append(ReflectivityModel)
385       
386        from sans.models.ReflectivityIIModel import ReflectivityIIModel
387        self.multi_func_list.append(ReflectivityIIModel)
388   
389        #Looking for plugins
390        self.plugins = findModels()
391        self._get_multifunc_models()
392        self.plugins.append(ReflectivityModel)
393        self.plugins.append(ReflectivityIIModel)
394        return 0
395
396   
397    def populate_menu(self, modelmenu, event_owner):
398        """
399        Populate a menu with our models
400       
401        :param id: first menu event ID to use when binding the menu events
402        :param modelmenu: wx.Menu object to populate
403        :param event_owner: wx object to bind the menu events to
404       
405        :return: the next free event ID following the new menu events
406       
407        """
408        ## Fill model lists
409        self._getModelList()
410        ## store reference to model menu of guiframe
411        self.modelmenu = modelmenu
412        ## guiframe reference
413        self.event_owner = event_owner
414       
415        shape_submenu = wx.Menu()
416        shape_indep_submenu = wx.Menu()
417        structure_factor = wx.Menu()
418        added_models = wx.Menu()
419        multip_models = wx.Menu()
420        ## create menu with shape
421        self._fill_simple_menu(menuinfo=["Shapes",shape_submenu," simple shape"],
422                         list1=self.shape_list)
423       
424        self._fill_simple_menu(menuinfo=["Shape-Independent",shape_indep_submenu,
425                                    "List of shape-independent models"],
426                         list1=self.shape_indep_list )
427       
428        self._fill_simple_menu(menuinfo=["Structure Factors",structure_factor,
429                                          "List of Structure factors models" ],
430                                list1=self.struct_list)
431       
432        self._fill_plugin_menu(menuinfo=["Customized Models", added_models,
433                                            "List of additional models"],
434                                 list1=self.plugins)
435       
436        self._fill_menu(menuinfo=["P(Q)*S(Q)",multip_models,
437                                  "mulplication of 2 models"],
438                                   list1=self.multiplication_factor ,
439                                   list2= self.struct_list)
440        return 0
441   
442    def _fill_plugin_menu(self, menuinfo, list1):
443        """
444        fill the plugin menu with costumized models
445        """
446        if len(list1)==0:
447            id = wx.NewId() 
448            msg= "No model available check plugins.log for errors to fix problem"
449            menuinfo[1].Append(int(id),"Empty",msg)
450        self._fill_simple_menu( menuinfo,list1)
451       
452    def _fill_simple_menu(self, menuinfo, list1):
453        """
454        Fill the menu with list item
455       
456        :param modelmenu: the menu to fill
457        :param menuinfo: submenu item for the first column of this modelmenu
458                         with info.Should be a list :
459                         [name(string) , menu(wx.menu), help(string)]
460        :param list1: contains item (form factor )to fill modelmenu second column
461       
462        """
463        if len(list1)>0:
464            self.model_combobox.set_list(menuinfo[0],list1)
465           
466            for item in list1:
467                try:
468                    id = wx.NewId() 
469                    struct_factor=item()
470                    struct_name = struct_factor.__class__.__name__
471                    if hasattr(struct_factor, "name"):
472                        struct_name = struct_factor.name
473                       
474                    menuinfo[1].Append(int(id),struct_name,struct_name)
475                    if not  item in self.struct_factor_dict.itervalues():
476                        self.struct_factor_dict[str(id)]= item
477                    wx.EVT_MENU(self.event_owner, int(id), self._on_model)
478                except:
479                    msg= "Error Occured: %s"%sys.exc_value
480                    wx.PostEvent(self.event_owner, StatusEvent(status=msg))
481               
482        id = wx.NewId()         
483        self.modelmenu.AppendMenu(id, menuinfo[0],menuinfo[1],menuinfo[2])
484       
485    def _fill_menu(self, menuinfo, list1, list2):
486        """
487        Fill the menu with list item
488       
489        :param menuinfo: submenu item for the first column of this modelmenu
490                         with info.Should be a list :
491                         [name(string) , menu(wx.menu), help(string)]
492        :param list1: contains item (form factor )to fill modelmenu second column
493        :param list2: contains item (Structure factor )to fill modelmenu
494                third column
495               
496        """
497        if len(list1)>0:
498            self.model_combobox.set_list(menuinfo[0],list1)
499           
500            for item in list1:   
501                form_factor= item()
502                form_name = form_factor.__class__.__name__
503                if hasattr(form_factor, "name"):
504                    form_name = form_factor.name
505                ### store form factor to return to other users   
506                newmenu= wx.Menu()
507                if len(list2)>0:
508                    for model  in list2:
509                        id = wx.NewId()
510                        struct_factor = model()
511                        name = struct_factor.__class__.__name__
512                        if hasattr(struct_factor, "name"):
513                            name = struct_factor.name
514                        newmenu.Append(id,name, name)
515                        wx.EVT_MENU(self.event_owner, int(id), self._on_model)
516                        ## save form_fact and struct_fact
517                        self.form_factor_dict[int(id)] = [form_factor,struct_factor]
518                       
519                form_id= wx.NewId()   
520                menuinfo[1].AppendMenu(int(form_id), form_name,newmenu,menuinfo[2])
521        id=wx.NewId()
522        self.modelmenu.AppendMenu(id,menuinfo[0],menuinfo[1], menuinfo[2])
523       
524    def _on_model(self, evt):
525        """
526        React to a model menu event
527       
528        :param event: wx menu event
529       
530        """
531        if int(evt.GetId()) in self.form_factor_dict.keys():
532            from sans.models.MultiplicationModel import MultiplicationModel
533            model1, model2 = self.form_factor_dict[int(evt.GetId())]
534            model = MultiplicationModel(model1, model2)   
535        else:
536            model= self.struct_factor_dict[str(evt.GetId())]()
537        evt = ModelEvent(model=model)
538        wx.PostEvent(self.event_owner, evt)
539       
540    def _get_multifunc_models(self):
541        """
542        Get the multifunctional models
543        """
544        for item in self.plugins:
545            try:
546                # check the multiplicity if any
547                if item.multiplicity_info[0] > 1:
548                    self.multi_func_list.append(item)
549            except:
550                # pass to other items
551                pass
552                   
553    def get_model_list(self):   
554        """
555        return dictionary of models for fitpanel use
556       
557        """
558        self.model_combobox.set_list("Shapes", self.shape_list)
559        self.model_combobox.set_list("Shape-Independent", self.shape_indep_list)
560        self.model_combobox.set_list("Structure Factors", self.struct_list)
561        self.model_combobox.set_list("Customized Models", self.plugins)
562        self.model_combobox.set_list("P(Q)*S(Q)", self.multiplication_factor)
563        self.model_combobox.set_list("multiplication", self.multiplication_factor)
564        self.model_combobox.set_list("Multi-Functions", self.multi_func_list)
565        return self.model_combobox
566   
567 
568       
569   
570   
571 
Note: See TracBrowser for help on using the repository browser.