source: sasview/src/sans/perspectives/fitting/models.py @ 77cfcf0

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 77cfcf0 was 201af9f, checked in by Miguel Gonzalez <onzalezm@…>, 11 years ago

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