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

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 df7a7e3 was df7a7e3, checked in by Mathieu Doucet <doucetm@…>, 12 years ago

merging category branch

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