source: sasview/fittingview/src/sans/perspectives/fitting/models.py @ f518eef

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 f518eef was f518eef, checked in by Robert Whitley <robert.whitley@…>, 12 years ago

Refs #84. Add the FractalO_Z model.

  • Property mode set to 100644
File size: 34.2 KB
Line 
1"""
2    Utilities to manage models
3"""
4import wx
5import imp
6import os
7import sys
8import math
9import os.path
10# Time is needed by the log method
11import time
12import logging
13import py_compile
14import shutil
15from sans.guiframe.events import StatusEvent
16# Explicitly import from the pluginmodel module so that py2exe
17# places it in the distribution. The Model1DPlugin class is used
18# as the base class of plug-in models.
19from sans.models.pluginmodel import Model1DPlugin
20   
21PLUGIN_DIR = 'plugin_models'
22
23
24def log(message):
25    """
26        Log a message in a file located in the user's home directory
27    """
28    dir = os.path.join(os.path.expanduser("~"), '.sansview', PLUGIN_DIR)
29    out = open(os.path.join(dir, "plugins.log"), 'a')
30    out.write("%10g%s\n" % (time.clock(), message))
31    out.close()
32
33
34def _check_plugin(model, name):
35    """
36    Do some checking before model adding plugins in the list
37   
38    :param model: class model to add into the plugin list
39    :param name:name of the module plugin
40   
41    :return model: model if valid model or None if not valid
42   
43    """
44    #Check is the plugin is of type Model1DPlugin
45    if not issubclass(model, Model1DPlugin):
46        msg = "Plugin %s must be of type Model1DPlugin \n" % str(name)
47        log(msg)
48        return None
49    if model.__name__ != "Model":
50        msg = "Plugin %s class name must be Model \n" % str(name)
51        log(msg)
52        return None
53    try:
54        new_instance = model()
55    except:
56        msg = "Plugin %s error in __init__ \n\t: %s %s\n" % (str(name),
57                                    str(sys.exc_type), sys.exc_value)
58        log(msg)
59        return None
60   
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 find_plugins_dir():
77    """
78        Find path of the plugins directory.
79        The plugin directory is located in the user's home directory.
80    """
81    dir = os.path.join(os.path.expanduser("~"), '.sansview', PLUGIN_DIR)
82   
83    # If the plugin directory doesn't exist, create it
84    if not os.path.isdir(dir):
85        os.makedirs(dir)
86       
87    # Find paths needed
88    try:
89        # For source
90        if os.path.isdir(os.path.dirname(__file__)):
91            p_dir = os.path.join(os.path.dirname(__file__), PLUGIN_DIR)
92        else:
93            raise
94    except:
95        # Check for data path next to exe/zip file.
96        #Look for maximum n_dir up of the current dir to find plugins dir
97        n_dir = 12
98        p_dir = None
99        f_dir = os.path.join(os.path.dirname(__file__))
100        for i in range(n_dir):
101            if i > 1:
102                f_dir, _ = os.path.split(f_dir)
103            plugin_path = os.path.join(f_dir, PLUGIN_DIR)
104            if os.path.isdir(plugin_path):
105                p_dir = plugin_path
106                break
107        if not p_dir:
108            raise
109    # Place example user models as needed
110    if os.path.isdir(p_dir):
111        for file in os.listdir(p_dir):
112            file_path = os.path.join(p_dir, file)
113            if os.path.isfile(file_path):
114                if file.split(".")[-1] == 'py' and\
115                    file.split(".")[0] != '__init__':
116                    if not os.path.isfile(os.path.join(dir, file)):
117                        shutil.copy(file_path, dir)
118
119    return dir
120
121
122class ReportProblem:
123    def __nonzero__(self):
124        type, value, traceback = sys.exc_info()
125        if type is not None and issubclass(type, py_compile.PyCompileError):
126            print "Problem with", repr(value)
127            raise type, value, traceback
128        return 1
129   
130report_problem = ReportProblem()
131
132
133def compile_file(dir):
134    """
135    Compile a py file
136    """
137    try:
138        import compileall
139        compileall.compile_dir(dir=dir, ddir=dir, force=1,
140                               quiet=report_problem)
141    except:
142        type, value, traceback = sys.exc_info()
143        return value
144    return None
145
146
147def _findModels(dir):
148    """
149    """
150    # List of plugin objects
151    plugins = {}
152    # Go through files in plug-in directory
153    #always recompile the folder plugin
154    dir = find_plugins_dir()
155    if not os.path.isdir(dir):
156        msg = "SansView couldn't locate Model plugin folder."
157        msg += """ "%s" does not exist""" % dir
158        logging.warning(msg)
159        return plugins
160    else:
161        log("looking for models in: %s" % str(dir))
162        compile_file(dir)
163        logging.info("pluging model dir: %s\n" % str(dir))
164    try:
165        list = os.listdir(dir)
166        for item in list:
167            toks = os.path.splitext(os.path.basename(item))
168            if toks[1] == '.py' and not toks[0] == '__init__':
169                name = toks[0]
170           
171                path = [os.path.abspath(dir)]
172                file = None
173                try:
174                    (file, path, info) = imp.find_module(name, path)
175                    module = imp.load_module(name, file, item, info)
176                    if hasattr(module, "Model"):
177                        try:
178                            if _check_plugin(module.Model, name) != None:
179                                plugins[name] = module.Model
180                        except:
181                            msg = "Error accessing Model"
182                            msg += "in %s\n  %s %s\n" % (name,
183                                    str(sys.exc_type), sys.exc_value)
184                            log(msg)
185                except:
186                    msg = "Error accessing Model"
187                    msg += " in %s\n  %s %s \n" % (name,
188                                    str(sys.exc_type), sys.exc_value)
189                    log(msg)
190                finally:
191             
192                    if not file == None:
193                        file.close()
194    except:
195        # Don't deal with bad plug-in imports. Just skip.
196        msg = "Could not import model plugin: %s\n" % sys.exc_value
197        log(msg)
198        pass
199    return plugins
200
201
202class ModelList(object):
203    """
204    Contains dictionary of model and their type
205    """
206    def __init__(self):
207        """
208        """
209        self.mydict = {}
210       
211    def set_list(self, name, mylist):
212        """
213        :param name: the type of the list
214        :param mylist: the list to add
215       
216        """
217        if name not in self.mydict.keys():
218            self.reset_list(name, mylist)
219           
220    def reset_list(self, name, mylist):
221        """
222        :param name: the type of the list
223        :param mylist: the list to add
224        """
225        self.mydict[name] = mylist
226           
227    def get_list(self):
228        """
229        return all the list stored in a dictionary object
230        """
231        return self.mydict
232       
233       
234class ModelManagerBase:
235    """
236        Base class for the model manager
237    """
238    ## external dict for models
239    model_combobox = ModelList()
240    ## Dictionary of form models
241    form_factor_dict = {}
242    ## dictionary of other
243    struct_factor_dict = {}
244    ##list of form factors
245    shape_list = []
246    ## independent shape model list
247    shape_indep_list = []
248    ##list of structure factors
249    struct_list = []
250    ##list of model allowing multiplication
251    multiplication_factor = []
252    ##list of multifunctional shapes
253    multi_func_list = []
254    ## list of added models
255    plugins = []
256    ## Event owner (guiframe)
257    event_owner = None
258    last_time_dir_modified = 0
259   
260    def __init__(self):
261        """
262        """
263        self.stored_plugins = {}
264        self._getModelList()
265       
266    def findModels(self):
267        """
268        find  plugin model in directory of plugin .recompile all file
269        in the directory if file were modified
270        """
271        temp = {}
272        if self.is_changed():
273            return  _findModels(dir)
274        logging.info("pluging model : %s\n" % str(temp))
275        return temp
276       
277    def _getModelList(self):
278        """
279        List of models we want to make available by default
280        for this application
281   
282        :return: the next free event ID following the new menu events
283       
284        """
285        # regular model names only
286        self.model_name_list = []
287        from sans.models.SphereModel import SphereModel
288        self.shape_list.append(SphereModel)
289        self.multiplication_factor.append(SphereModel)
290        self.model_name_list.append(SphereModel.__name__)
291       
292        from sans.models.BinaryHSModel import BinaryHSModel
293        self.shape_list.append(BinaryHSModel)
294        self.model_name_list.append(BinaryHSModel.__name__)
295                       
296        from sans.models.FuzzySphereModel import FuzzySphereModel
297        self.shape_list.append(FuzzySphereModel)
298        self.multiplication_factor.append(FuzzySphereModel)
299        self.model_name_list.append(FuzzySphereModel.__name__)
300                       
301        from sans.models.RaspBerryModel import RaspBerryModel
302        self.shape_list.append(RaspBerryModel)
303        self.model_name_list.append(RaspBerryModel.__name__)
304               
305        from sans.models.CoreShellModel import CoreShellModel
306        self.shape_list.append(CoreShellModel)
307        self.multiplication_factor.append(CoreShellModel)
308        self.model_name_list.append(CoreShellModel.__name__)
309       
310        from sans.models.Core2ndMomentModel import Core2ndMomentModel
311        self.shape_list.append(Core2ndMomentModel)
312        self.model_name_list.append(Core2ndMomentModel.__name__)
313       
314        from sans.models.CoreMultiShellModel import CoreMultiShellModel
315        self.shape_list.append(CoreMultiShellModel)
316        self.multiplication_factor.append(CoreMultiShellModel)
317        self.multi_func_list.append(CoreMultiShellModel)
318
319        from sans.models.VesicleModel import VesicleModel
320        self.shape_list.append(VesicleModel)
321        self.multiplication_factor.append(VesicleModel)
322        self.model_name_list.append(VesicleModel.__name__)
323       
324        from sans.models.MultiShellModel import MultiShellModel
325        self.shape_list.append(MultiShellModel)
326        self.multiplication_factor.append(MultiShellModel)
327        self.model_name_list.append(MultiShellModel.__name__)
328       
329        from sans.models.OnionExpShellModel import OnionExpShellModel
330        self.shape_list.append(OnionExpShellModel)
331        self.multiplication_factor.append(OnionExpShellModel)
332        self.multi_func_list.append(OnionExpShellModel)
333                         
334        from sans.models.SphericalSLDModel import SphericalSLDModel
335        self.shape_list.append(SphericalSLDModel)
336        self.multiplication_factor.append(SphericalSLDModel)
337        self.multi_func_list.append(SphericalSLDModel)
338       
339        from sans.models.LinearPearlsModel import LinearPearlsModel
340        self.shape_list.append(LinearPearlsModel)
341        self.model_name_list.append(LinearPearlsModel.__name__)
342         
343        from sans.models.PearlNecklaceModel import PearlNecklaceModel
344        self.shape_list.append(PearlNecklaceModel)
345        self.model_name_list.append(PearlNecklaceModel.__name__)
346        #self.multiplication_factor.append(PearlNecklaceModel)
347       
348        from sans.models.CylinderModel import CylinderModel
349        self.shape_list.append(CylinderModel)
350        self.multiplication_factor.append(CylinderModel)
351        self.model_name_list.append(CylinderModel.__name__)
352       
353        from sans.models.CoreShellCylinderModel import CoreShellCylinderModel
354        self.shape_list.append(CoreShellCylinderModel)
355        self.multiplication_factor.append(CoreShellCylinderModel)
356        self.model_name_list.append(CoreShellCylinderModel.__name__)
357       
358        from sans.models.CoreShellBicelleModel import CoreShellBicelleModel
359        self.shape_list.append(CoreShellBicelleModel)
360        self.multiplication_factor.append(CoreShellBicelleModel)
361        self.model_name_list.append(CoreShellBicelleModel.__name__)
362               
363        from sans.models.HollowCylinderModel import HollowCylinderModel
364        self.shape_list.append(HollowCylinderModel)
365        self.multiplication_factor.append(HollowCylinderModel)
366        self.model_name_list.append(HollowCylinderModel.__name__)
367             
368        from sans.models.FlexibleCylinderModel import FlexibleCylinderModel
369        self.shape_list.append(FlexibleCylinderModel)
370        self.model_name_list.append(FlexibleCylinderModel.__name__)
371
372        from sans.models.FlexCylEllipXModel import FlexCylEllipXModel
373        self.shape_list.append(FlexCylEllipXModel)
374        self.model_name_list.append(FlexCylEllipXModel.__name__)
375       
376        from sans.models.StackedDisksModel import StackedDisksModel
377        self.shape_list.append(StackedDisksModel)
378        self.multiplication_factor.append(StackedDisksModel)
379        self.model_name_list.append(StackedDisksModel.__name__)
380       
381        from sans.models.ParallelepipedModel import ParallelepipedModel
382        self.shape_list.append(ParallelepipedModel)
383        self.multiplication_factor.append(ParallelepipedModel)
384        self.model_name_list.append(ParallelepipedModel.__name__)
385       
386        from sans.models.CSParallelepipedModel import CSParallelepipedModel
387        self.shape_list.append(CSParallelepipedModel)
388        self.multiplication_factor.append(CSParallelepipedModel)
389        self.model_name_list.append(CSParallelepipedModel.__name__)
390       
391        from sans.models.EllipticalCylinderModel import EllipticalCylinderModel
392        self.shape_list.append(EllipticalCylinderModel)
393        self.multiplication_factor.append(EllipticalCylinderModel)
394        self.model_name_list.append(EllipticalCylinderModel.__name__)
395       
396        from sans.models.BarBellModel import BarBellModel
397        self.shape_list.append(BarBellModel)
398        self.model_name_list.append(BarBellModel.__name__)
399        # not implemeted yet!
400        #self.multiplication_factor.append(BarBellModel)
401       
402        from sans.models.CappedCylinderModel import CappedCylinderModel
403        self.shape_list.append(CappedCylinderModel)
404        self.model_name_list.append(CappedCylinderModel.__name__)
405        # not implemeted yet!
406        #self.multiplication_factor.append(CappedCylinderModel)
407       
408        from sans.models.EllipsoidModel import EllipsoidModel
409        self.shape_list.append(EllipsoidModel)
410        self.multiplication_factor.append(EllipsoidModel)
411        self.model_name_list.append(EllipsoidModel.__name__)
412     
413        from sans.models.CoreShellEllipsoidModel import CoreShellEllipsoidModel
414        self.shape_list.append(CoreShellEllipsoidModel)
415        self.multiplication_factor.append(CoreShellEllipsoidModel)
416        self.model_name_list.append(CoreShellEllipsoidModel.__name__)
417         
418        from sans.models.TriaxialEllipsoidModel import TriaxialEllipsoidModel
419        self.shape_list.append(TriaxialEllipsoidModel)
420        self.multiplication_factor.append(TriaxialEllipsoidModel)
421        self.model_name_list.append(TriaxialEllipsoidModel.__name__)
422       
423        from sans.models.LamellarModel import LamellarModel
424        self.shape_list.append(LamellarModel)
425        self.model_name_list.append(LamellarModel.__name__)
426       
427        from sans.models.LamellarFFHGModel import LamellarFFHGModel
428        self.shape_list.append(LamellarFFHGModel)
429        self.model_name_list.append(LamellarFFHGModel.__name__)
430       
431        from sans.models.LamellarPSModel import LamellarPSModel
432        self.shape_list.append(LamellarPSModel)
433        self.model_name_list.append(LamellarPSModel.__name__)
434     
435        from sans.models.LamellarPSHGModel import LamellarPSHGModel
436        self.shape_list.append(LamellarPSHGModel)
437        self.model_name_list.append(LamellarPSHGModel.__name__)
438       
439        from sans.models.LamellarPCrystalModel import LamellarPCrystalModel
440        self.shape_list.append(LamellarPCrystalModel)
441        self.model_name_list.append(LamellarPCrystalModel.__name__)
442       
443        from sans.models.SCCrystalModel import SCCrystalModel
444        self.shape_list.append(SCCrystalModel)
445        self.model_name_list.append(SCCrystalModel.__name__)
446       
447        from sans.models.FCCrystalModel import FCCrystalModel
448        self.shape_list.append(FCCrystalModel)
449        self.model_name_list.append(FCCrystalModel.__name__)
450       
451        from sans.models.BCCrystalModel import BCCrystalModel
452        self.shape_list.append(BCCrystalModel)
453        self.model_name_list.append(BCCrystalModel.__name__)
454     
455        ## Structure factor
456        from sans.models.SquareWellStructure import SquareWellStructure
457        self.struct_list.append(SquareWellStructure)
458        self.model_name_list.append(SquareWellStructure.__name__)
459       
460        from sans.models.HardsphereStructure import HardsphereStructure
461        self.struct_list.append(HardsphereStructure)
462        self.model_name_list.append(HardsphereStructure.__name__)
463         
464        from sans.models.StickyHSStructure import StickyHSStructure
465        self.struct_list.append(StickyHSStructure)
466        self.model_name_list.append(StickyHSStructure.__name__)
467       
468        from sans.models.HayterMSAStructure import HayterMSAStructure
469        self.struct_list.append(HayterMSAStructure)
470        self.model_name_list.append(HayterMSAStructure.__name__)
471       
472        ##shape-independent models
473        from sans.models.PowerLawAbsModel import PowerLawAbsModel
474        self.shape_indep_list.append(PowerLawAbsModel)
475        self.model_name_list.append(PowerLawAbsModel.__name__)
476       
477        from sans.models.BEPolyelectrolyte import BEPolyelectrolyte
478        self.shape_indep_list.append(BEPolyelectrolyte)
479        self.model_name_list.append(BEPolyelectrolyte.__name__)
480        self.form_factor_dict[str(wx.NewId())] =  [SphereModel]
481       
482        from sans.models.BroadPeakModel import BroadPeakModel
483        self.shape_indep_list.append(BroadPeakModel)
484        self.model_name_list.append(BroadPeakModel.__name__)
485       
486        from sans.models.CorrLengthModel import CorrLengthModel
487        self.shape_indep_list.append(CorrLengthModel)
488        self.model_name_list.append(CorrLengthModel.__name__)
489       
490        from sans.models.DABModel import DABModel
491        self.shape_indep_list.append(DABModel)
492        self.model_name_list.append(DABModel.__name__)
493       
494        from sans.models.DebyeModel import DebyeModel
495        self.shape_indep_list.append(DebyeModel)
496        self.model_name_list.append(DebyeModel.__name__)
497       
498        from sans.models.FractalModel import FractalModel
499        self.shape_indep_list.append(FractalModel)
500        self.model_name_list.append(FractalModel.__name__)
501       
502        from sans.models.FractalCoreShellModel import FractalCoreShellModel
503        self.shape_indep_list.append(FractalCoreShellModel)
504        self.model_name_list.append(FractalCoreShellModel.__name__)
505       
506        from sans.models.GaussLorentzGelModel import GaussLorentzGelModel
507        self.shape_indep_list.append(GaussLorentzGelModel)
508        self.model_name_list.append(GaussLorentzGelModel.__name__)
509               
510        from sans.models.GuinierModel import GuinierModel
511        self.shape_indep_list.append(GuinierModel)
512        self.model_name_list.append(GuinierModel.__name__)
513       
514        from sans.models.GuinierPorodModel import GuinierPorodModel
515        self.shape_indep_list.append(GuinierPorodModel)
516        self.model_name_list.append(GuinierPorodModel.__name__)
517
518        from sans.models.LorentzModel import LorentzModel
519        self.shape_indep_list.append(LorentzModel)
520        self.model_name_list.append(LorentzModel.__name__)
521
522        from sans.models.MassFractalModel import MassFractalModel
523        self.shape_indep_list.append(MassFractalModel)
524        self.model_name_list.append(MassFractalModel.__name__)
525       
526        from sans.models.MassSurfaceFractal import MassSurfaceFractal
527        self.shape_indep_list.append(MassSurfaceFractal)
528        self.model_name_list.append(MassSurfaceFractal.__name__)
529       
530        from sans.models.PeakGaussModel import PeakGaussModel
531        self.shape_indep_list.append(PeakGaussModel)
532        self.model_name_list.append(PeakGaussModel.__name__)
533       
534        from sans.models.PeakLorentzModel import PeakLorentzModel
535        self.shape_indep_list.append(PeakLorentzModel)
536        self.model_name_list.append(PeakLorentzModel.__name__)
537       
538        from sans.models.Poly_GaussCoil import Poly_GaussCoil
539        self.shape_indep_list.append(Poly_GaussCoil)
540        self.model_name_list.append(Poly_GaussCoil.__name__)
541       
542        from sans.models.PolymerExclVolume import PolymerExclVolume
543        self.shape_indep_list.append(PolymerExclVolume)
544        self.model_name_list.append(PolymerExclVolume.__name__)
545       
546        from sans.models.PorodModel import PorodModel
547        self.shape_indep_list.append(PorodModel)
548        self.model_name_list.append(PorodModel.__name__)
549       
550        from sans.models.RPA10Model import RPA10Model
551        self.shape_indep_list.append(RPA10Model)
552        self.multi_func_list.append(RPA10Model)
553
554        from sans.models.SurfaceFractalModel import SurfaceFractalModel
555        self.shape_indep_list.append(SurfaceFractalModel)
556        self.model_name_list.append(SurfaceFractalModel.__name__)
557       
558        from sans.models.TeubnerStreyModel import TeubnerStreyModel
559        self.shape_indep_list.append(TeubnerStreyModel)
560        self.model_name_list.append(TeubnerStreyModel.__name__)
561
562        from sans.models.TwoLorentzianModel import TwoLorentzianModel
563        self.shape_indep_list.append(TwoLorentzianModel)
564        self.model_name_list.append(TwoLorentzianModel.__name__)
565       
566        from sans.models.TwoPowerLawModel import TwoPowerLawModel
567        self.shape_indep_list.append(TwoPowerLawModel)
568        self.model_name_list.append(TwoPowerLawModel.__name__)
569       
570        from sans.models.UnifiedPowerRgModel import UnifiedPowerRgModel
571        self.shape_indep_list.append(UnifiedPowerRgModel)
572        self.multi_func_list.append(UnifiedPowerRgModel)
573
574        from sans.models.LineModel import LineModel
575        self.shape_indep_list.append(LineModel)
576        self.model_name_list.append(LineModel.__name__)
577       
578        from sans.models.ReflectivityModel import ReflectivityModel
579        self.shape_indep_list.append(ReflectivityModel)
580        self.multi_func_list.append(ReflectivityModel)
581       
582        from sans.models.ReflectivityIIModel import ReflectivityIIModel
583        self.shape_indep_list.append(ReflectivityIIModel)
584        self.multi_func_list.append(ReflectivityIIModel)
585       
586        from sans.models.GelFitModel import GelFitModel
587        self.shape_indep_list.append(GelFitModel)
588        self.model_name_list.append(GelFitModel.__name__)
589       
590        from sans.models.FractalO_Z import FractalO_Z
591        self.shape_indep_list.append(FractalO_Z)
592        self.model_name_list.append(FractalO_Z.__name__)
593   
594        #Looking for plugins
595        self.stored_plugins = self.findModels()
596        self.plugins = self.stored_plugins.values()
597
598        self._get_multifunc_models()
599       
600        return 0
601
602    def is_changed(self):
603        """
604        check the last time the plugin dir has changed and return true
605         is the directory was modified else return false
606        """
607        is_modified = False
608        plugin_dir = find_plugins_dir()
609        if os.path.isdir(plugin_dir):
610            temp = os.path.getmtime(plugin_dir)
611            if  self.last_time_dir_modified != temp:
612                is_modified = True
613                self.last_time_dir_modified = temp
614       
615        return is_modified
616   
617    def update(self):
618        """
619        return a dictionary of model if
620        new models were added else return empty dictionary
621        """
622        new_plugins = self.findModels()
623        if len(new_plugins) > 0:
624            for name, plug in  new_plugins.iteritems():
625                if name not in self.stored_plugins.keys():
626                    self.stored_plugins[name] = plug
627                    self.plugins.append(plug)
628            self.model_combobox.set_list("Customized Models", self.plugins)
629            return self.model_combobox.get_list()
630        else:
631            return {}
632   
633    def pulgins_reset(self):
634        """
635        return a dictionary of model
636        """
637        self.plugins = []
638        new_plugins = _findModels(dir)
639        for name, plug in  new_plugins.iteritems():
640            for stored_name, stored_plug in self.stored_plugins.iteritems():
641                if name == stored_name:
642                    del self.stored_plugins[name]
643                    break
644            self.stored_plugins[name] = plug
645            self.plugins.append(plug)
646
647        self.model_combobox.reset_list("Customized Models", self.plugins)
648        return self.model_combobox.get_list()
649       
650    def populate_menu(self, modelmenu, event_owner):
651        """
652        Populate a menu with our models
653       
654        :param id: first menu event ID to use when binding the menu events
655        :param modelmenu: wx.Menu object to populate
656        :param event_owner: wx object to bind the menu events to
657       
658        :return: the next free event ID following the new menu events
659       
660        """
661        ## Fill model lists
662        self._getModelList()
663        ## store reference to model menu of guiframe
664        self.modelmenu = modelmenu
665        ## guiframe reference
666        self.event_owner = event_owner
667       
668        shape_submenu = wx.Menu()
669        shape_indep_submenu = wx.Menu()
670        structure_factor = wx.Menu()
671        added_models = wx.Menu()
672        multip_models = wx.Menu()
673        ## create menu with shape
674        self._fill_simple_menu(menuinfo=["Shapes",
675                                         shape_submenu,
676                                         " simple shape"],
677                         list1=self.shape_list)
678       
679        self._fill_simple_menu(menuinfo=["Shape-Independent",
680                                         shape_indep_submenu,
681                                         "List of shape-independent models"],
682                         list1=self.shape_indep_list)
683       
684        self._fill_simple_menu(menuinfo=["Structure Factors",
685                                         structure_factor,
686                                         "List of Structure factors models"],
687                                list1=self.struct_list)
688       
689        self._fill_plugin_menu(menuinfo=["Customized Models", added_models,
690                                            "List of additional models"],
691                                 list1=self.plugins)
692       
693        self._fill_menu(menuinfo=["P(Q)*S(Q)", multip_models,
694                                  "mulplication of 2 models"],
695                                   list1=self.multiplication_factor,
696                                   list2=self.struct_list)
697        return 0
698   
699    def _fill_plugin_menu(self, menuinfo, list1):
700        """
701        fill the plugin menu with costumized models
702        """
703        if len(list1) == 0:
704            id = wx.NewId()
705            msg = "No model available check plugins.log for errors to fix problem"
706            menuinfo[1].Append(int(id), "Empty", msg)
707        self._fill_simple_menu(menuinfo, list1)
708       
709    def _fill_simple_menu(self, menuinfo, list1):
710        """
711        Fill the menu with list item
712       
713        :param modelmenu: the menu to fill
714        :param menuinfo: submenu item for the first column of this modelmenu
715                         with info.Should be a list :
716                         [name(string) , menu(wx.menu), help(string)]
717        :param list1: contains item (form factor )to fill modelmenu second column
718       
719        """
720        if len(list1) > 0:
721            self.model_combobox.set_list(menuinfo[0], list1)
722           
723            for item in list1:
724                try:
725                    id = wx.NewId()
726                    struct_factor = item()
727                    struct_name = struct_factor.__class__.__name__
728                    if hasattr(struct_factor, "name"):
729                        struct_name = struct_factor.name
730                       
731                    menuinfo[1].Append(int(id), struct_name, struct_name)
732                    if not  item in self.struct_factor_dict.itervalues():
733                        self.struct_factor_dict[str(id)] = item
734                    wx.EVT_MENU(self.event_owner, int(id), self._on_model)
735                except:
736                    msg = "Error Occured: %s" % sys.exc_value
737                    wx.PostEvent(self.event_owner, StatusEvent(status=msg))
738               
739        id = wx.NewId()
740        self.modelmenu.AppendMenu(id, menuinfo[0], menuinfo[1], menuinfo[2])
741       
742    def _fill_menu(self, menuinfo, list1, list2):
743        """
744        Fill the menu with list item
745       
746        :param menuinfo: submenu item for the first column of this modelmenu
747                         with info.Should be a list :
748                         [name(string) , menu(wx.menu), help(string)]
749        :param list1: contains item (form factor )to fill modelmenu second column
750        :param list2: contains item (Structure factor )to fill modelmenu
751                third column
752               
753        """
754        if len(list1) > 0:
755            self.model_combobox.set_list(menuinfo[0], list1)
756           
757            for item in list1:
758                form_factor = item()
759                form_name = form_factor.__class__.__name__
760                if hasattr(form_factor, "name"):
761                    form_name = form_factor.name
762                ### store form factor to return to other users
763                newmenu = wx.Menu()
764                if len(list2) > 0:
765                    for model  in list2:
766                        id = wx.NewId()
767                        struct_factor = model()
768                        name = struct_factor.__class__.__name__
769                        if hasattr(struct_factor, "name"):
770                            name = struct_factor.name
771                        newmenu.Append(id, name, name)
772                        wx.EVT_MENU(self.event_owner, int(id), self._on_model)
773                        ## save form_fact and struct_fact
774                        self.form_factor_dict[int(id)] = [form_factor,
775                                                          struct_factor]
776                       
777                form_id = wx.NewId()
778                menuinfo[1].AppendMenu(int(form_id), form_name,
779                                       newmenu, menuinfo[2])
780        id = wx.NewId()
781        self.modelmenu.AppendMenu(id, menuinfo[0], menuinfo[1], menuinfo[2])
782       
783    def _on_model(self, evt):
784        """
785        React to a model menu event
786       
787        :param event: wx menu event
788       
789        """
790        if int(evt.GetId()) in self.form_factor_dict.keys():
791            from sans.models.MultiplicationModel import MultiplicationModel
792            model1, model2 = self.form_factor_dict[int(evt.GetId())]
793            model = MultiplicationModel(model1, model2)
794        else:
795            model = self.struct_factor_dict[str(evt.GetId())]()
796       
797        #TODO: investigate why the following two lines were left in the code
798        #      even though the ModelEvent class doesn't exist
799        #evt = ModelEvent(model=model)
800        #wx.PostEvent(self.event_owner, evt)
801       
802    def _get_multifunc_models(self):
803        """
804        Get the multifunctional models
805        """
806        for item in self.plugins:
807            try:
808                # check the multiplicity if any
809                if item.multiplicity_info[0] > 1:
810                    self.multi_func_list.append(item)
811            except:
812                # pass to other items
813                pass
814                   
815    def get_model_list(self):
816        """
817        return dictionary of models for fitpanel use
818       
819        """
820        self.model_combobox.set_list("Shapes", self.shape_list)
821        self.model_combobox.set_list("Shape-Independent",
822                                     self.shape_indep_list)
823        self.model_combobox.set_list("Structure Factors", self.struct_list)
824        self.model_combobox.set_list("Customized Models", self.plugins)
825        self.model_combobox.set_list("P(Q)*S(Q)", self.multiplication_factor)
826        self.model_combobox.set_list("multiplication",
827                                     self.multiplication_factor)
828        self.model_combobox.set_list("Multi-Functions", self.multi_func_list)
829        return self.model_combobox.get_list()
830   
831    def get_model_name_list(self):
832        """
833        return regular model name list
834        """
835        return self.model_name_list
836 
837       
838class ModelManager(object):
839    """
840    implement model
841    """
842    __modelmanager = ModelManagerBase()
843   
844    def findModels(self):
845        return self.__modelmanager.findModels()
846   
847    def _getModelList(self):
848        return self.__modelmanager._getModelList()
849   
850    def is_changed(self):
851        return self.__modelmanager.is_changed()
852   
853    def update(self):
854        return self.__modelmanager.update()
855   
856    def pulgins_reset(self):
857        return self.__modelmanager.pulgins_reset()
858   
859    def populate_menu(self, modelmenu, event_owner):
860        return self.__modelmanager.populate_menu(modelmenu, event_owner)
861   
862    def _on_model(self, evt):
863        return self.__modelmanager._on_model(evt)
864   
865    def _get_multifunc_models(self):
866        return self.__modelmanager._get_multifunc_models()
867   
868    def get_model_list(self):
869        return self.__modelmanager.get_model_list()
870   
871    def get_model_name_list(self):
872        return self.__modelmanager.get_model_name_list()
Note: See TracBrowser for help on using the repository browser.