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

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 316e231 was 19e614a, checked in by Jae Cho <jhjcho@…>, 13 years ago

let users be able to delete default custom models (WIN app only)

  • Property mode set to 100644
File size: 33.6 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.CoreShellModel import CoreShellModel
302        self.shape_list.append(CoreShellModel)
303        self.multiplication_factor.append(CoreShellModel)
304        self.model_name_list.append(CoreShellModel.__name__)
305       
306        from sans.models.Core2ndMomentModel import Core2ndMomentModel
307        self.shape_list.append(Core2ndMomentModel)
308        self.model_name_list.append(Core2ndMomentModel.__name__)
309       
310        from sans.models.CoreMultiShellModel import CoreMultiShellModel
311        self.shape_list.append(CoreMultiShellModel)
312        self.multiplication_factor.append(CoreMultiShellModel)
313        self.multi_func_list.append(CoreMultiShellModel)
314
315        from sans.models.VesicleModel import VesicleModel
316        self.shape_list.append(VesicleModel)
317        self.multiplication_factor.append(VesicleModel)
318        self.model_name_list.append(VesicleModel.__name__)
319       
320        from sans.models.MultiShellModel import MultiShellModel
321        self.shape_list.append(MultiShellModel)
322        self.multiplication_factor.append(MultiShellModel)
323        self.model_name_list.append(MultiShellModel.__name__)
324       
325        from sans.models.OnionExpShellModel import OnionExpShellModel
326        self.shape_list.append(OnionExpShellModel)
327        self.multiplication_factor.append(OnionExpShellModel)
328        self.multi_func_list.append(OnionExpShellModel)
329                         
330        from sans.models.SphericalSLDModel import SphericalSLDModel
331        self.shape_list.append(SphericalSLDModel)
332        self.multiplication_factor.append(SphericalSLDModel)
333        self.multi_func_list.append(SphericalSLDModel)
334       
335        from sans.models.LinearPearlsModel import LinearPearlsModel
336        self.shape_list.append(LinearPearlsModel)
337        self.model_name_list.append(LinearPearlsModel.__name__)
338         
339        from sans.models.PearlNecklaceModel import PearlNecklaceModel
340        self.shape_list.append(PearlNecklaceModel)
341        self.model_name_list.append(PearlNecklaceModel.__name__)
342        #self.multiplication_factor.append(PearlNecklaceModel)
343       
344        from sans.models.CylinderModel import CylinderModel
345        self.shape_list.append(CylinderModel)
346        self.multiplication_factor.append(CylinderModel)
347        self.model_name_list.append(CylinderModel.__name__)
348       
349        from sans.models.CoreShellCylinderModel import CoreShellCylinderModel
350        self.shape_list.append(CoreShellCylinderModel)
351        self.multiplication_factor.append(CoreShellCylinderModel)
352        self.model_name_list.append(CoreShellCylinderModel.__name__)
353       
354        from sans.models.CoreShellBicelleModel import CoreShellBicelleModel
355        self.shape_list.append(CoreShellBicelleModel)
356        self.multiplication_factor.append(CoreShellBicelleModel)
357        self.model_name_list.append(CoreShellBicelleModel.__name__)
358               
359        from sans.models.HollowCylinderModel import HollowCylinderModel
360        self.shape_list.append(HollowCylinderModel)
361        self.multiplication_factor.append(HollowCylinderModel)
362        self.model_name_list.append(HollowCylinderModel.__name__)
363             
364        from sans.models.FlexibleCylinderModel import FlexibleCylinderModel
365        self.shape_list.append(FlexibleCylinderModel)
366        self.model_name_list.append(FlexibleCylinderModel.__name__)
367
368        from sans.models.FlexCylEllipXModel import FlexCylEllipXModel
369        self.shape_list.append(FlexCylEllipXModel)
370        self.model_name_list.append(FlexCylEllipXModel.__name__)
371       
372        from sans.models.StackedDisksModel import StackedDisksModel
373        self.shape_list.append(StackedDisksModel)
374        self.multiplication_factor.append(StackedDisksModel)
375        self.model_name_list.append(StackedDisksModel.__name__)
376       
377        from sans.models.ParallelepipedModel import ParallelepipedModel
378        self.shape_list.append(ParallelepipedModel)
379        self.multiplication_factor.append(ParallelepipedModel)
380        self.model_name_list.append(ParallelepipedModel.__name__)
381       
382        from sans.models.CSParallelepipedModel import CSParallelepipedModel
383        self.shape_list.append(CSParallelepipedModel)
384        self.multiplication_factor.append(CSParallelepipedModel)
385        self.model_name_list.append(CSParallelepipedModel.__name__)
386       
387        from sans.models.EllipticalCylinderModel import EllipticalCylinderModel
388        self.shape_list.append(EllipticalCylinderModel)
389        self.multiplication_factor.append(EllipticalCylinderModel)
390        self.model_name_list.append(EllipticalCylinderModel.__name__)
391       
392        from sans.models.BarBellModel import BarBellModel
393        self.shape_list.append(BarBellModel)
394        self.model_name_list.append(BarBellModel.__name__)
395        # not implemeted yet!
396        #self.multiplication_factor.append(BarBellModel)
397       
398        from sans.models.CappedCylinderModel import CappedCylinderModel
399        self.shape_list.append(CappedCylinderModel)
400        self.model_name_list.append(CappedCylinderModel.__name__)
401        # not implemeted yet!
402        #self.multiplication_factor.append(CappedCylinderModel)
403       
404        from sans.models.EllipsoidModel import EllipsoidModel
405        self.shape_list.append(EllipsoidModel)
406        self.multiplication_factor.append(EllipsoidModel)
407        self.model_name_list.append(EllipsoidModel.__name__)
408     
409        from sans.models.CoreShellEllipsoidModel import CoreShellEllipsoidModel
410        self.shape_list.append(CoreShellEllipsoidModel)
411        self.multiplication_factor.append(CoreShellEllipsoidModel)
412        self.model_name_list.append(CoreShellEllipsoidModel.__name__)
413         
414        from sans.models.TriaxialEllipsoidModel import TriaxialEllipsoidModel
415        self.shape_list.append(TriaxialEllipsoidModel)
416        self.multiplication_factor.append(TriaxialEllipsoidModel)
417        self.model_name_list.append(TriaxialEllipsoidModel.__name__)
418       
419        from sans.models.LamellarModel import LamellarModel
420        self.shape_list.append(LamellarModel)
421        self.model_name_list.append(LamellarModel.__name__)
422       
423        from sans.models.LamellarFFHGModel import LamellarFFHGModel
424        self.shape_list.append(LamellarFFHGModel)
425        self.model_name_list.append(LamellarFFHGModel.__name__)
426       
427        from sans.models.LamellarPSModel import LamellarPSModel
428        self.shape_list.append(LamellarPSModel)
429        self.model_name_list.append(LamellarPSModel.__name__)
430     
431        from sans.models.LamellarPSHGModel import LamellarPSHGModel
432        self.shape_list.append(LamellarPSHGModel)
433        self.model_name_list.append(LamellarPSHGModel.__name__)
434       
435        from sans.models.LamellarPCrystalModel import LamellarPCrystalModel
436        self.shape_list.append(LamellarPCrystalModel)
437        self.model_name_list.append(LamellarPCrystalModel.__name__)
438       
439        from sans.models.SCCrystalModel import SCCrystalModel
440        self.shape_list.append(SCCrystalModel)
441        self.model_name_list.append(SCCrystalModel.__name__)
442       
443        from sans.models.FCCrystalModel import FCCrystalModel
444        self.shape_list.append(FCCrystalModel)
445        self.model_name_list.append(FCCrystalModel.__name__)
446       
447        from sans.models.BCCrystalModel import BCCrystalModel
448        self.shape_list.append(BCCrystalModel)
449        self.model_name_list.append(BCCrystalModel.__name__)
450     
451        ## Structure factor
452        from sans.models.SquareWellStructure import SquareWellStructure
453        self.struct_list.append(SquareWellStructure)
454        self.model_name_list.append(SquareWellStructure.__name__)
455       
456        from sans.models.HardsphereStructure import HardsphereStructure
457        self.struct_list.append(HardsphereStructure)
458        self.model_name_list.append(HardsphereStructure.__name__)
459         
460        from sans.models.StickyHSStructure import StickyHSStructure
461        self.struct_list.append(StickyHSStructure)
462        self.model_name_list.append(StickyHSStructure.__name__)
463       
464        from sans.models.HayterMSAStructure import HayterMSAStructure
465        self.struct_list.append(HayterMSAStructure)
466        self.model_name_list.append(HayterMSAStructure.__name__)
467       
468        ##shape-independent models
469        from sans.models.PowerLawAbsModel import PowerLawAbsModel
470        self.shape_indep_list.append(PowerLawAbsModel)
471        self.model_name_list.append(PowerLawAbsModel.__name__)
472       
473        from sans.models.BEPolyelectrolyte import BEPolyelectrolyte
474        self.shape_indep_list.append(BEPolyelectrolyte)
475        self.model_name_list.append(BEPolyelectrolyte.__name__)
476        self.form_factor_dict[str(wx.NewId())] =  [SphereModel]
477       
478        from sans.models.BroadPeakModel import BroadPeakModel
479        self.shape_indep_list.append(BroadPeakModel)
480        self.model_name_list.append(BroadPeakModel.__name__)
481       
482        from sans.models.CorrLengthModel import CorrLengthModel
483        self.shape_indep_list.append(CorrLengthModel)
484        self.model_name_list.append(CorrLengthModel.__name__)
485       
486        from sans.models.DABModel import DABModel
487        self.shape_indep_list.append(DABModel)
488        self.model_name_list.append(DABModel.__name__)
489       
490        from sans.models.DebyeModel import DebyeModel
491        self.shape_indep_list.append(DebyeModel)
492        self.model_name_list.append(DebyeModel.__name__)
493       
494        from sans.models.FractalModel import FractalModel
495        self.shape_indep_list.append(FractalModel)
496        self.model_name_list.append(FractalModel.__name__)
497       
498        from sans.models.FractalCoreShellModel import FractalCoreShellModel
499        self.shape_indep_list.append(FractalCoreShellModel)
500        self.model_name_list.append(FractalCoreShellModel.__name__)
501       
502        from sans.models.GaussLorentzGelModel import GaussLorentzGelModel
503        self.shape_indep_list.append(GaussLorentzGelModel)
504        self.model_name_list.append(GaussLorentzGelModel.__name__)
505               
506        from sans.models.GuinierModel import GuinierModel
507        self.shape_indep_list.append(GuinierModel)
508        self.model_name_list.append(GuinierModel.__name__)
509       
510        from sans.models.GuinierPorodModel import GuinierPorodModel
511        self.shape_indep_list.append(GuinierPorodModel)
512        self.model_name_list.append(GuinierPorodModel.__name__)
513
514        from sans.models.LorentzModel import LorentzModel
515        self.shape_indep_list.append(LorentzModel)
516        self.model_name_list.append(LorentzModel.__name__)
517
518        from sans.models.MassFractalModel import MassFractalModel
519        self.shape_indep_list.append(MassFractalModel)
520        self.model_name_list.append(MassFractalModel.__name__)
521       
522        from sans.models.MassSurfaceFractal import MassSurfaceFractal
523        self.shape_indep_list.append(MassSurfaceFractal)
524        self.model_name_list.append(MassSurfaceFractal.__name__)
525       
526        from sans.models.PeakGaussModel import PeakGaussModel
527        self.shape_indep_list.append(PeakGaussModel)
528        self.model_name_list.append(PeakGaussModel.__name__)
529       
530        from sans.models.PeakLorentzModel import PeakLorentzModel
531        self.shape_indep_list.append(PeakLorentzModel)
532        self.model_name_list.append(PeakLorentzModel.__name__)
533       
534        from sans.models.Poly_GaussCoil import Poly_GaussCoil
535        self.shape_indep_list.append(Poly_GaussCoil)
536        self.model_name_list.append(Poly_GaussCoil.__name__)
537       
538        from sans.models.PolymerExclVolume import PolymerExclVolume
539        self.shape_indep_list.append(PolymerExclVolume)
540        self.model_name_list.append(PolymerExclVolume.__name__)
541       
542        from sans.models.PorodModel import PorodModel
543        self.shape_indep_list.append(PorodModel)
544        self.model_name_list.append(PorodModel.__name__)
545       
546        from sans.models.RPA10Model import RPA10Model
547        self.shape_indep_list.append(RPA10Model)
548        self.multi_func_list.append(RPA10Model)
549
550        from sans.models.SurfaceFractalModel import SurfaceFractalModel
551        self.shape_indep_list.append(SurfaceFractalModel)
552        self.model_name_list.append(SurfaceFractalModel.__name__)
553       
554        from sans.models.TeubnerStreyModel import TeubnerStreyModel
555        self.shape_indep_list.append(TeubnerStreyModel)
556        self.model_name_list.append(TeubnerStreyModel.__name__)
557       
558        from sans.models.TwoLorentzianModel import TwoLorentzianModel
559        self.shape_indep_list.append(TwoLorentzianModel)
560        self.model_name_list.append(TwoLorentzianModel.__name__)
561       
562        from sans.models.TwoPowerLawModel import TwoPowerLawModel
563        self.shape_indep_list.append(TwoPowerLawModel)
564        self.model_name_list.append(TwoPowerLawModel.__name__)
565       
566        from sans.models.UnifiedPowerRgModel import UnifiedPowerRgModel
567        self.shape_indep_list.append(UnifiedPowerRgModel)
568        self.multi_func_list.append(UnifiedPowerRgModel)
569       
570        from sans.models.LineModel import LineModel
571        self.shape_indep_list.append(LineModel)
572        self.model_name_list.append(LineModel.__name__)
573       
574        from sans.models.ReflectivityModel import ReflectivityModel
575        self.shape_indep_list.append(ReflectivityModel)
576        self.multi_func_list.append(ReflectivityModel)
577       
578        from sans.models.ReflectivityIIModel import ReflectivityIIModel
579        self.shape_indep_list.append(ReflectivityIIModel)
580        self.multi_func_list.append(ReflectivityIIModel)
581   
582        #Looking for plugins
583        self.stored_plugins = self.findModels()
584        self.plugins = self.stored_plugins.values()
585
586        self._get_multifunc_models()
587       
588        return 0
589
590    def is_changed(self):
591        """
592        check the last time the plugin dir has changed and return true
593         is the directory was modified else return false
594        """
595        is_modified = False
596        plugin_dir = find_plugins_dir()
597        if os.path.isdir(plugin_dir):
598            temp = os.path.getmtime(plugin_dir)
599            if  self.last_time_dir_modified != temp:
600                is_modified = True
601                self.last_time_dir_modified = temp
602       
603        return is_modified
604   
605    def update(self):
606        """
607        return a dictionary of model if
608        new models were added else return empty dictionary
609        """
610        new_plugins = self.findModels()
611        if len(new_plugins) > 0:
612            for name, plug in  new_plugins.iteritems():
613                if name not in self.stored_plugins.keys():
614                    self.stored_plugins[name] = plug
615                    self.plugins.append(plug)
616            self.model_combobox.set_list("Customized Models", self.plugins)
617            return self.model_combobox.get_list()
618        else:
619            return {}
620   
621    def pulgins_reset(self):
622        """
623        return a dictionary of model
624        """
625        self.plugins = []
626        new_plugins = _findModels(dir)
627        for name, plug in  new_plugins.iteritems():
628            for stored_name, stored_plug in self.stored_plugins.iteritems():
629                if name == stored_name:
630                    del self.stored_plugins[name]
631                    break
632            self.stored_plugins[name] = plug
633            self.plugins.append(plug)
634
635        self.model_combobox.reset_list("Customized Models", self.plugins)
636        return self.model_combobox.get_list()
637       
638    def populate_menu(self, modelmenu, event_owner):
639        """
640        Populate a menu with our models
641       
642        :param id: first menu event ID to use when binding the menu events
643        :param modelmenu: wx.Menu object to populate
644        :param event_owner: wx object to bind the menu events to
645       
646        :return: the next free event ID following the new menu events
647       
648        """
649        ## Fill model lists
650        self._getModelList()
651        ## store reference to model menu of guiframe
652        self.modelmenu = modelmenu
653        ## guiframe reference
654        self.event_owner = event_owner
655       
656        shape_submenu = wx.Menu()
657        shape_indep_submenu = wx.Menu()
658        structure_factor = wx.Menu()
659        added_models = wx.Menu()
660        multip_models = wx.Menu()
661        ## create menu with shape
662        self._fill_simple_menu(menuinfo=["Shapes",
663                                         shape_submenu,
664                                         " simple shape"],
665                         list1=self.shape_list)
666       
667        self._fill_simple_menu(menuinfo=["Shape-Independent",
668                                         shape_indep_submenu,
669                                         "List of shape-independent models"],
670                         list1=self.shape_indep_list)
671       
672        self._fill_simple_menu(menuinfo=["Structure Factors",
673                                         structure_factor,
674                                         "List of Structure factors models"],
675                                list1=self.struct_list)
676       
677        self._fill_plugin_menu(menuinfo=["Customized Models", added_models,
678                                            "List of additional models"],
679                                 list1=self.plugins)
680       
681        self._fill_menu(menuinfo=["P(Q)*S(Q)", multip_models,
682                                  "mulplication of 2 models"],
683                                   list1=self.multiplication_factor,
684                                   list2=self.struct_list)
685        return 0
686   
687    def _fill_plugin_menu(self, menuinfo, list1):
688        """
689        fill the plugin menu with costumized models
690        """
691        if len(list1) == 0:
692            id = wx.NewId()
693            msg = "No model available check plugins.log for errors to fix problem"
694            menuinfo[1].Append(int(id), "Empty", msg)
695        self._fill_simple_menu(menuinfo, list1)
696       
697    def _fill_simple_menu(self, menuinfo, list1):
698        """
699        Fill the menu with list item
700       
701        :param modelmenu: the menu to fill
702        :param menuinfo: submenu item for the first column of this modelmenu
703                         with info.Should be a list :
704                         [name(string) , menu(wx.menu), help(string)]
705        :param list1: contains item (form factor )to fill modelmenu second column
706       
707        """
708        if len(list1) > 0:
709            self.model_combobox.set_list(menuinfo[0], list1)
710           
711            for item in list1:
712                try:
713                    id = wx.NewId()
714                    struct_factor = item()
715                    struct_name = struct_factor.__class__.__name__
716                    if hasattr(struct_factor, "name"):
717                        struct_name = struct_factor.name
718                       
719                    menuinfo[1].Append(int(id), struct_name, struct_name)
720                    if not  item in self.struct_factor_dict.itervalues():
721                        self.struct_factor_dict[str(id)] = item
722                    wx.EVT_MENU(self.event_owner, int(id), self._on_model)
723                except:
724                    msg = "Error Occured: %s" % sys.exc_value
725                    wx.PostEvent(self.event_owner, StatusEvent(status=msg))
726               
727        id = wx.NewId()
728        self.modelmenu.AppendMenu(id, menuinfo[0], menuinfo[1], menuinfo[2])
729       
730    def _fill_menu(self, menuinfo, list1, list2):
731        """
732        Fill the menu with list item
733       
734        :param menuinfo: submenu item for the first column of this modelmenu
735                         with info.Should be a list :
736                         [name(string) , menu(wx.menu), help(string)]
737        :param list1: contains item (form factor )to fill modelmenu second column
738        :param list2: contains item (Structure factor )to fill modelmenu
739                third column
740               
741        """
742        if len(list1) > 0:
743            self.model_combobox.set_list(menuinfo[0], list1)
744           
745            for item in list1:
746                form_factor = item()
747                form_name = form_factor.__class__.__name__
748                if hasattr(form_factor, "name"):
749                    form_name = form_factor.name
750                ### store form factor to return to other users
751                newmenu = wx.Menu()
752                if len(list2) > 0:
753                    for model  in list2:
754                        id = wx.NewId()
755                        struct_factor = model()
756                        name = struct_factor.__class__.__name__
757                        if hasattr(struct_factor, "name"):
758                            name = struct_factor.name
759                        newmenu.Append(id, name, name)
760                        wx.EVT_MENU(self.event_owner, int(id), self._on_model)
761                        ## save form_fact and struct_fact
762                        self.form_factor_dict[int(id)] = [form_factor,
763                                                          struct_factor]
764                       
765                form_id = wx.NewId()
766                menuinfo[1].AppendMenu(int(form_id), form_name,
767                                       newmenu, menuinfo[2])
768        id = wx.NewId()
769        self.modelmenu.AppendMenu(id, menuinfo[0], menuinfo[1], menuinfo[2])
770       
771    def _on_model(self, evt):
772        """
773        React to a model menu event
774       
775        :param event: wx menu event
776       
777        """
778        if int(evt.GetId()) in self.form_factor_dict.keys():
779            from sans.models.MultiplicationModel import MultiplicationModel
780            model1, model2 = self.form_factor_dict[int(evt.GetId())]
781            model = MultiplicationModel(model1, model2)
782        else:
783            model = self.struct_factor_dict[str(evt.GetId())]()
784       
785        #TODO: investigate why the following two lines were left in the code
786        #      even though the ModelEvent class doesn't exist
787        #evt = ModelEvent(model=model)
788        #wx.PostEvent(self.event_owner, evt)
789       
790    def _get_multifunc_models(self):
791        """
792        Get the multifunctional models
793        """
794        for item in self.plugins:
795            try:
796                # check the multiplicity if any
797                if item.multiplicity_info[0] > 1:
798                    self.multi_func_list.append(item)
799            except:
800                # pass to other items
801                pass
802                   
803    def get_model_list(self):
804        """
805        return dictionary of models for fitpanel use
806       
807        """
808        self.model_combobox.set_list("Shapes", self.shape_list)
809        self.model_combobox.set_list("Shape-Independent",
810                                     self.shape_indep_list)
811        self.model_combobox.set_list("Structure Factors", self.struct_list)
812        self.model_combobox.set_list("Customized Models", self.plugins)
813        self.model_combobox.set_list("P(Q)*S(Q)", self.multiplication_factor)
814        self.model_combobox.set_list("multiplication",
815                                     self.multiplication_factor)
816        self.model_combobox.set_list("Multi-Functions", self.multi_func_list)
817        return self.model_combobox.get_list()
818   
819    def get_model_name_list(self):
820        """
821        return regular model name list
822        """
823        return self.model_name_list
824 
825       
826class ModelManager(object):
827    """
828    implement model
829    """
830    __modelmanager = ModelManagerBase()
831   
832    def findModels(self):
833        return self.__modelmanager.findModels()
834   
835    def _getModelList(self):
836        return self.__modelmanager._getModelList()
837   
838    def is_changed(self):
839        return self.__modelmanager.is_changed()
840   
841    def update(self):
842        return self.__modelmanager.update()
843   
844    def pulgins_reset(self):
845        return self.__modelmanager.pulgins_reset()
846   
847    def populate_menu(self, modelmenu, event_owner):
848        return self.__modelmanager.populate_menu(modelmenu, event_owner)
849   
850    def _on_model(self, evt):
851        return self.__modelmanager._on_model(evt)
852   
853    def _get_multifunc_models(self):
854        return self.__modelmanager._get_multifunc_models()
855   
856    def get_model_list(self):
857        return self.__modelmanager.get_model_list()
858   
859    def get_model_name_list(self):
860        return self.__modelmanager.get_model_name_list()
Note: See TracBrowser for help on using the repository browser.