source: sasview/sansview/perspectives/fitting/models.py @ 20905a0

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 20905a0 was a1b2471, checked in by Jae Cho <jhjcho@…>, 14 years ago

added sld plot for onion model and etc…

  • Property mode set to 100644
File size: 18.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        ## form factor
175        from sans.models.SphereModel import SphereModel
176        self.shape_list.append(SphereModel)
177        self.multiplication_factor.append(SphereModel)
178       
179        from sans.models.SphereExpShellModel import SphereExpShellModel
180        self.shape_list.append(SphereExpShellModel)
181        self.multiplication_factor.append(SphereExpShellModel)
182        self.multi_func_list.append(SphereExpShellModel)
183       
184        from sans.models.FuzzySphereModel import FuzzySphereModel
185        self.shape_list.append(FuzzySphereModel)
186        self.multiplication_factor.append(FuzzySphereModel)
187       
188        from sans.models.CoreShellModel import CoreShellModel
189        self.shape_list.append(CoreShellModel)
190        self.multiplication_factor.append(CoreShellModel)
191       
192        from sans.models.CoreMultiShellModel import CoreMultiShellModel
193        self.shape_list.append(CoreMultiShellModel)
194        self.multiplication_factor.append(CoreMultiShellModel)
195        self.multi_func_list.append(CoreMultiShellModel)
196       
197        from sans.models.VesicleModel import VesicleModel
198        self.shape_list.append(VesicleModel)
199        self.multiplication_factor.append(VesicleModel)
200       
201        from sans.models.MultiShellModel import MultiShellModel
202        self.shape_list.append(MultiShellModel)
203        self.multiplication_factor.append(MultiShellModel)
204       
205        from sans.models.BinaryHSModel import BinaryHSModel
206        self.shape_list.append(BinaryHSModel)
207       
208        from sans.models.CylinderModel import CylinderModel
209        self.shape_list.append(CylinderModel)
210        self.multiplication_factor.append(CylinderModel)
211       
212        from sans.models.CoreShellCylinderModel import CoreShellCylinderModel
213        self.shape_list.append(CoreShellCylinderModel)
214        self.multiplication_factor.append(CoreShellCylinderModel)
215       
216        from sans.models.HollowCylinderModel import HollowCylinderModel
217        self.shape_list.append(HollowCylinderModel)
218        self.multiplication_factor.append(HollowCylinderModel)
219             
220        from sans.models.FlexibleCylinderModel import FlexibleCylinderModel
221        self.shape_list.append(FlexibleCylinderModel)
222
223        from sans.models.FlexCylEllipXModel import FlexCylEllipXModel
224        self.shape_list.append(FlexCylEllipXModel)
225       
226        from sans.models.StackedDisksModel import StackedDisksModel
227        self.shape_list.append(StackedDisksModel)
228        self.multiplication_factor.append(StackedDisksModel)
229       
230        from sans.models.ParallelepipedModel import ParallelepipedModel
231        self.shape_list.append(ParallelepipedModel)
232        self.multiplication_factor.append(ParallelepipedModel)
233       
234        from sans.models.EllipticalCylinderModel import EllipticalCylinderModel
235        self.shape_list.append(EllipticalCylinderModel)
236        self.multiplication_factor.append(EllipticalCylinderModel)
237               
238        from sans.models.EllipsoidModel import EllipsoidModel
239        self.shape_list.append(EllipsoidModel)
240        self.multiplication_factor.append(EllipsoidModel)
241     
242        from sans.models.CoreShellEllipsoidModel import CoreShellEllipsoidModel
243        self.shape_list.append(CoreShellEllipsoidModel)
244        self.multiplication_factor.append(CoreShellEllipsoidModel)
245         
246        from sans.models.TriaxialEllipsoidModel import TriaxialEllipsoidModel
247        self.shape_list.append(TriaxialEllipsoidModel)
248        self.multiplication_factor.append(TriaxialEllipsoidModel)
249       
250        from sans.models.LamellarModel import LamellarModel
251        self.shape_list.append(LamellarModel)
252       
253        from sans.models.LamellarFFHGModel import LamellarFFHGModel
254        self.shape_list.append(LamellarFFHGModel)
255       
256        from sans.models.LamellarPSModel import LamellarPSModel
257        self.shape_list.append(LamellarPSModel)
258     
259        from sans.models.LamellarPSHGModel import LamellarPSHGModel
260        self.shape_list.append(LamellarPSHGModel)
261     
262        ## Structure factor
263        from sans.models.SquareWellStructure import SquareWellStructure
264        self.struct_list.append(SquareWellStructure)
265       
266        from sans.models.HardsphereStructure import HardsphereStructure
267        self.struct_list.append(HardsphereStructure)
268         
269        from sans.models.StickyHSStructure import StickyHSStructure
270        self.struct_list.append(StickyHSStructure)
271       
272        from sans.models.HayterMSAStructure import HayterMSAStructure
273        self.struct_list.append(HayterMSAStructure)
274   
275        ##shape-independent models 
276        from sans.models.PowerLawAbsModel import PowerLawAbsModel
277        self.shape_indep_list.append( PowerLawAbsModel )
278       
279        from sans.models.BEPolyelectrolyte import BEPolyelectrolyte
280        self.shape_indep_list.append(BEPolyelectrolyte )
281        self.form_factor_dict[str(wx.NewId())] =  [SphereModel]
282
283        from sans.models.DABModel import DABModel
284        self.shape_indep_list.append(DABModel )
285       
286        from sans.models.DebyeModel import DebyeModel
287        self.shape_indep_list.append(DebyeModel )
288       
289        from sans.models.GuinierModel import GuinierModel
290        self.shape_indep_list.append(GuinierModel )
291       
292        from sans.models.FractalModel import FractalModel
293        self.shape_indep_list.append(FractalModel )
294       
295        from sans.models.LorentzModel import LorentzModel
296        self.shape_indep_list.append( LorentzModel) 
297       
298        from sans.models.PeakGaussModel import PeakGaussModel
299        self.shape_indep_list.append(PeakGaussModel)
300       
301        from sans.models.PeakLorentzModel import PeakLorentzModel
302        self.shape_indep_list.append(PeakLorentzModel)
303       
304        from sans.models.Poly_GaussCoil import Poly_GaussCoil
305        self.shape_indep_list.append(Poly_GaussCoil)
306                 
307        from sans.models.PorodModel import PorodModel
308        self.shape_indep_list.append(PorodModel )
309       
310        #FractalModel (a c-model)will be used.
311        #from sans.models.FractalAbsModel import FractalAbsModel
312        #self.shape_indep_list.append(FractalAbsModel)
313       
314        from sans.models.TeubnerStreyModel import TeubnerStreyModel
315        self.shape_indep_list.append(TeubnerStreyModel )
316       
317        from sans.models.LineModel import LineModel
318        self.shape_indep_list.append(LineModel)
319       
320        #Looking for plugins
321        self.plugins = findModels()
322        return 0
323
324   
325    def populate_menu(self, modelmenu, event_owner):
326        """
327        Populate a menu with our models
328       
329        :param id: first menu event ID to use when binding the menu events
330        :param modelmenu: wx.Menu object to populate
331        :param event_owner: wx object to bind the menu events to
332       
333        :return: the next free event ID following the new menu events
334       
335        """
336        ## Fill model lists
337        self._getModelList()
338        ## store reference to model menu of guiframe
339        self.modelmenu = modelmenu
340        ## guiframe reference
341        self.event_owner = event_owner
342       
343        shape_submenu = wx.Menu()
344        shape_indep_submenu = wx.Menu()
345        structure_factor = wx.Menu()
346        added_models = wx.Menu()
347        multip_models = wx.Menu()
348        ## create menu with shape
349        self._fill_simple_menu(menuinfo=["Shapes",shape_submenu," simple shape"],
350                         list1=self.shape_list)
351       
352        self._fill_simple_menu(menuinfo=["Shape-Independent",shape_indep_submenu,
353                                    "List of shape-independent models"],
354                         list1=self.shape_indep_list )
355       
356        self._fill_simple_menu(menuinfo=["Structure Factors",structure_factor,
357                                          "List of Structure factors models" ],
358                                list1=self.struct_list)
359       
360        self._fill_plugin_menu(menuinfo=["Customized Models", added_models,
361                                            "List of additional models"],
362                                 list1=self.plugins)
363       
364        self._fill_menu(menuinfo=["P(Q)*S(Q)",multip_models,
365                                  "mulplication of 2 models"],
366                                   list1=self.multiplication_factor ,
367                                   list2= self.struct_list)
368        return 0
369   
370    def _fill_plugin_menu(self, menuinfo, list1):
371        """
372        fill the plugin menu with costumized models
373        """
374        if len(list1)==0:
375            id = wx.NewId() 
376            msg= "No model available check plugins.log for errors to fix problem"
377            menuinfo[1].Append(int(id),"Empty",msg)
378        self._fill_simple_menu( menuinfo,list1)
379       
380    def _fill_simple_menu(self, menuinfo, list1):
381        """
382        Fill the menu with list item
383       
384        :param modelmenu: the menu to fill
385        :param menuinfo: submenu item for the first column of this modelmenu
386                         with info.Should be a list :
387                         [name(string) , menu(wx.menu), help(string)]
388        :param list1: contains item (form factor )to fill modelmenu second column
389       
390        """
391        if len(list1)>0:
392            self.model_combobox.set_list(menuinfo[0],list1)
393           
394            for item in list1:
395                try:
396                    id = wx.NewId() 
397                    struct_factor=item()
398                    struct_name = struct_factor.__class__.__name__
399                    if hasattr(struct_factor, "name"):
400                        struct_name = struct_factor.name
401                       
402                    menuinfo[1].Append(int(id),struct_name,struct_name)
403                    if not  item in self.struct_factor_dict.itervalues():
404                        self.struct_factor_dict[str(id)]= item
405                    wx.EVT_MENU(self.event_owner, int(id), self._on_model)
406                except:
407                    msg= "Error Occured: %s"%sys.exc_value
408                    wx.PostEvent(self.event_owner, StatusEvent(status=msg))
409               
410        id = wx.NewId()         
411        self.modelmenu.AppendMenu(id, menuinfo[0],menuinfo[1],menuinfo[2])
412       
413    def _fill_menu(self, menuinfo, list1, list2):
414        """
415        Fill the menu with list item
416       
417        :param menuinfo: submenu item for the first column of this modelmenu
418                         with info.Should be a list :
419                         [name(string) , menu(wx.menu), help(string)]
420        :param list1: contains item (form factor )to fill modelmenu second column
421        :param list2: contains item (Structure factor )to fill modelmenu
422                third column
423               
424        """
425        if len(list1)>0:
426            self.model_combobox.set_list(menuinfo[0],list1)
427           
428            for item in list1:   
429                form_factor= item()
430                form_name = form_factor.__class__.__name__
431                if hasattr(form_factor, "name"):
432                    form_name = form_factor.name
433                ### store form factor to return to other users   
434                newmenu= wx.Menu()
435                if len(list2)>0:
436                    for model  in list2:
437                        id = wx.NewId()
438                        struct_factor = model()
439                        name = struct_factor.__class__.__name__
440                        if hasattr(struct_factor, "name"):
441                            name = struct_factor.name
442                        newmenu.Append(id,name, name)
443                        wx.EVT_MENU(self.event_owner, int(id), self._on_model)
444                        ## save form_fact and struct_fact
445                        self.form_factor_dict[int(id)] = [form_factor,struct_factor]
446                       
447                form_id= wx.NewId()   
448                menuinfo[1].AppendMenu(int(form_id), form_name,newmenu,menuinfo[2])
449        id=wx.NewId()
450        self.modelmenu.AppendMenu(id,menuinfo[0],menuinfo[1], menuinfo[2])
451       
452    def _on_model(self, evt):
453        """
454        React to a model menu event
455       
456        :param event: wx menu event
457       
458        """
459        if int(evt.GetId()) in self.form_factor_dict.keys():
460            from sans.models.MultiplicationModel import MultiplicationModel
461            model1, model2 = self.form_factor_dict[int(evt.GetId())]
462            model = MultiplicationModel(model1, model2)   
463        else:
464            model= self.struct_factor_dict[str(evt.GetId())]()
465        evt = ModelEvent( model= model )
466        wx.PostEvent(self.event_owner, evt)
467       
468    def get_model_list(self):   
469        """
470        return dictionary of models for fitpanel use
471       
472        """
473        self.model_combobox.set_list("multiplication", self.multiplication_factor)
474        self.model_combobox.set_list("Multi-Functions", self.multi_func_list)
475        return self.model_combobox
476   
477 
478       
479   
480   
481 
Note: See TracBrowser for help on using the repository browser.