source: sasview/theoryview/perspectives/theory/models.py @ b70caa1

"""
This module collects models from sans.models packages and orders theses models 
by categories that GUI application understands and uses.

"""
import wx
import wx.lib.newevent
import imp
import os,sys,math
import os.path

(ModelEvent, EVT_MODEL) = wx.lib.newevent.NewEvent()
from sans.guicomm.events import StatusEvent  
# Time is needed by the log method
import time

# Explicitly import from the pluginmodel module so that py2exe
# places it in the distribution. The Model1DPlugin class is used
# as the base class of plug-in models.
from sans.models.pluginmodel import Model1DPlugin
    
def log(message):
    """
    """
    out = open("plugins.log", 'a')
    out.write("%10g:  %s\n" % (time.clock(), message))
    out.close()

def findModels():
    """
    """
    log("looking for models in: %s/plugins" % os.getcwd())
    if os.path.isdir('plugins'):
        return _findModels('plugins')
    return []
    
def _check_plugin(model, name):
    """
    Do some checking before model adding plugins in the list
    
    :param model: class model to add into the plugin list
    :param name: name of the module plugin
    
    :return model: model if valid model or None if not valid
    
    """
    #Check is the plugin is of type Model1DPlugin
    if not issubclass(model, Model1DPlugin):
        msg= "Plugin %s must be of type Model1DPlugin \n"%str(name)
        log(msg)
        return None
    if model.__name__!="Model":
        msg= "Plugin %s class name must be Model \n"%str(name)
        log(msg)
        return None
    try:
        new_instance= model()
    except:
        msg="Plugin %s error in __init__ \n\t: %s %s\n"%(str(name),
                                    str(sys.exc_type),sys.exc_value)
        log(msg)
        return None
   
    new_instance= model() 
    if hasattr(new_instance,"function"):
        try:
           value=new_instance.function()
        except:
           msg="Plugin %s: error writing function \n\t :%s %s\n "%(str(name),
                                    str(sys.exc_type),sys.exc_value)
           log(msg)
           return None
    else:
       msg="Plugin  %s needs a method called function \n"%str(name)
       log(msg)
       return None
    return model
  
  
def _findModels(dir):
    """
    """
    # List of plugin objects
    plugins = []
    # Go through files in plug-in directory
    try:
        list = os.listdir(dir)
        for item in list:
            toks = os.path.splitext(os.path.basename(item))
            if toks[1]=='.py' and not toks[0]=='__init__':
                name = toks[0]
            
                path = [os.path.abspath(dir)]
                file = None
                try:
                    (file, path, info) = imp.find_module(name, path)
                    module = imp.load_module( name, file, item, info )
                    if hasattr(module, "Model"):
                        try:
                            if _check_plugin(module.Model, name)!=None:
                                plugins.append(module.Model)
                        except:
                            msg="Error accessing Model"
                            msg+="in %s\n  %s %s\n" % (name,
                                    str(sys.exc_type), sys.exc_value)
                            log(msg)
                except:
                    msg="Error accessing Model"
                    msg +=" in %s\n  %s %s \n" %(name,
                                    str(sys.exc_type), sys.exc_value)
                    log(msg)
                finally:
              
                    if not file==None:
                        file.close()
    except:
        # Don't deal with bad plug-in imports. Just skip.
        pass
    return plugins

class ModelList(object):
    """
    Contains dictionary of model and their type
    
    """
    def __init__(self):
        self.mydict={}
        
    def set_list(self, name, mylist):
        """
        
        :param name: the type of the list
        :param mylist: the list to add
        
        """
        if name not in self.mydict.keys():
            self.mydict[name] = mylist
            
            
    def get_list(self):
        """
        return all the list stored in a dictionary object
        """
        return self.mydict
        
class ModelManager:
    """
    ModelManager collected model classes object of available into a 
    dictionary of models' names and models' classes.
    
    """
    ## external dict for models
    model_combobox = ModelList()
    ## Dictionary of form models
    form_factor_dict = {}
    ## dictionary of other
    struct_factor_dict = {}
    ##list of form factors
    shape_list =[]
    ## independent shape model list
    shape_indep_list = []
    ##list of structure factors 
    struct_list= []
    ##list of model allowing multiplication
    multiplication_factor=[]
    ##list of multifunctional shapes
    multi_func_list =[]
    ## list of added models
    plugins=[]
    ## Event owner (guiframe)
    event_owner = None
    
    def _getModelList(self):
        """
        Fill up lists of models available by default
        for the current application
    
        :return: the next free event ID following the new menu events
        
        """
        ## form factor
        from sans.models.SphereModel import SphereModel
        self.shape_list.append(SphereModel)
        self.multiplication_factor.append(SphereModel)
              
        from sans.models.BinaryHSModel import BinaryHSModel
        self.shape_list.append(BinaryHSModel)
        
        from sans.models.FuzzySphereModel import FuzzySphereModel
        self.shape_list.append(FuzzySphereModel)
        self.multiplication_factor.append(FuzzySphereModel)
           
        from sans.models.CoreShellModel import CoreShellModel
        self.shape_list.append(CoreShellModel)
        self.multiplication_factor.append(CoreShellModel)
        
        from sans.models.CoreMultiShellModel import CoreMultiShellModel
        self.shape_list.append(CoreMultiShellModel)
        self.multiplication_factor.append(CoreMultiShellModel)
        self.multi_func_list.append(CoreMultiShellModel)

        from sans.models.VesicleModel import VesicleModel
        self.shape_list.append(VesicleModel)
        self.multiplication_factor.append(VesicleModel)
        
        from sans.models.MultiShellModel import MultiShellModel
        self.shape_list.append(MultiShellModel)
        self.multiplication_factor.append(MultiShellModel)
        
        from sans.models.OnionExpShellModel import OnionExpShellModel
        self.shape_list.append(OnionExpShellModel)
        self.multiplication_factor.append(OnionExpShellModel)
        self.multi_func_list.append(OnionExpShellModel)  
        
        from sans.models.SphericalSLDModel import SphericalSLDModel
        self.shape_list.append(SphericalSLDModel)
        self.multiplication_factor.append(SphericalSLDModel)
        self.multi_func_list.append(SphericalSLDModel)
        
        
        from sans.models.CylinderModel import CylinderModel
        self.shape_list.append(CylinderModel)
        self.multiplication_factor.append(CylinderModel)
        
        from sans.models.CoreShellCylinderModel import CoreShellCylinderModel
        self.shape_list.append(CoreShellCylinderModel)
        self.multiplication_factor.append(CoreShellCylinderModel)
        
        from sans.models.HollowCylinderModel import HollowCylinderModel
        self.shape_list.append(HollowCylinderModel)
        self.multiplication_factor.append(HollowCylinderModel)
              
        from sans.models.FlexibleCylinderModel import FlexibleCylinderModel
        self.shape_list.append(FlexibleCylinderModel)

        from sans.models.FlexCylEllipXModel import FlexCylEllipXModel
        self.shape_list.append(FlexCylEllipXModel)
        
        from sans.models.StackedDisksModel import StackedDisksModel
        self.shape_list.append(StackedDisksModel)
        self.multiplication_factor.append(StackedDisksModel)
        
        from sans.models.ParallelepipedModel import ParallelepipedModel
        self.shape_list.append(ParallelepipedModel)
        self.multiplication_factor.append(ParallelepipedModel)
        
        from sans.models.CSParallelepipedModel import CSParallelepipedModel
        self.shape_list.append(CSParallelepipedModel)
        self.multiplication_factor.append(CSParallelepipedModel)
        
        from sans.models.EllipticalCylinderModel import EllipticalCylinderModel
        self.shape_list.append(EllipticalCylinderModel)
        self.multiplication_factor.append(EllipticalCylinderModel)
        
        from sans.models.BarBellModel import BarBellModel
        self.shape_list.append(BarBellModel)
        # not implemeted yet!
        #self.multiplication_factor.append(BarBellModel)
        
        from sans.models.CappedCylinderModel import CappedCylinderModel
        self.shape_list.append(CappedCylinderModel)
        # not implemeted yet!
        #self.multiplication_factor.append(CappedCylinderModel)
        
        from sans.models.EllipsoidModel import EllipsoidModel
        self.shape_list.append(EllipsoidModel)
        self.multiplication_factor.append(EllipsoidModel)
      
        from sans.models.CoreShellEllipsoidModel import CoreShellEllipsoidModel
        self.shape_list.append(CoreShellEllipsoidModel)
        self.multiplication_factor.append(CoreShellEllipsoidModel)
         
        from sans.models.TriaxialEllipsoidModel import TriaxialEllipsoidModel
        self.shape_list.append(TriaxialEllipsoidModel)
        self.multiplication_factor.append(TriaxialEllipsoidModel)
        
        from sans.models.LamellarModel import LamellarModel
        self.shape_list.append(LamellarModel)
        
        from sans.models.LamellarFFHGModel import LamellarFFHGModel
        self.shape_list.append(LamellarFFHGModel)
        
        from sans.models.LamellarPSModel import LamellarPSModel
        self.shape_list.append(LamellarPSModel)
     
        from sans.models.LamellarPSHGModel import LamellarPSHGModel
        self.shape_list.append(LamellarPSHGModel)
        
        from sans.models.LamellarPCrystalModel import LamellarPCrystalModel
        self.shape_list.append(LamellarPCrystalModel)
        
        from sans.models.SCCrystalModel import SCCrystalModel
        self.shape_list.append(SCCrystalModel)
        
        from sans.models.FCCrystalModel import FCCrystalModel
        self.shape_list.append(FCCrystalModel)
        
        from sans.models.BCCrystalModel import BCCrystalModel
        self.shape_list.append(BCCrystalModel)
      
        ## Structure factor 
        from sans.models.SquareWellStructure import SquareWellStructure
        self.struct_list.append(SquareWellStructure)
        
        from sans.models.HardsphereStructure import HardsphereStructure
        self.struct_list.append(HardsphereStructure)
         
        from sans.models.StickyHSStructure import StickyHSStructure
        self.struct_list.append(StickyHSStructure)
        
        from sans.models.HayterMSAStructure import HayterMSAStructure
        self.struct_list.append(HayterMSAStructure)
        
        
        ##shape-independent models
            
        from sans.models.PowerLawAbsModel import PowerLawAbsModel
        self.shape_indep_list.append( PowerLawAbsModel )
        
        from sans.models.BEPolyelectrolyte import BEPolyelectrolyte
        self.shape_indep_list.append(BEPolyelectrolyte )
        self.form_factor_dict[str(wx.NewId())] =  [SphereModel]
        
        from sans.models.BroadPeakModel import BroadPeakModel
        self.shape_indep_list.append(BroadPeakModel)
        
        from sans.models.CorrLengthModel import CorrLengthModel
        self.shape_indep_list.append(CorrLengthModel)
        
        from sans.models.DABModel import DABModel
        self.shape_indep_list.append(DABModel )
        
        from sans.models.DebyeModel import DebyeModel
        self.shape_indep_list.append(DebyeModel )
        
        #FractalModel (a c-model)is now being used instead of FractalAbsModel.
        from sans.models.FractalModel import FractalModel
        self.shape_indep_list.append(FractalModel )
        
        from sans.models.FractalCoreShellModel import FractalCoreShellModel
        self.shape_indep_list.append(FractalCoreShellModel )
        
        from sans.models.GaussLorentzGelModel import GaussLorentzGelModel
        self.shape_indep_list.append(GaussLorentzGelModel) 
                
        from sans.models.GuinierModel import GuinierModel
        self.shape_indep_list.append(GuinierModel )
        
        from sans.models.GuinierPorodModel import GuinierPorodModel
        self.shape_indep_list.append(GuinierPorodModel )

        from sans.models.LorentzModel import LorentzModel
        self.shape_indep_list.append( LorentzModel) 
        
        from sans.models.PeakGaussModel import PeakGaussModel
        self.shape_indep_list.append(PeakGaussModel)
        
        from sans.models.PeakLorentzModel import PeakLorentzModel
        self.shape_indep_list.append(PeakLorentzModel)
        
        from sans.models.Poly_GaussCoil import Poly_GaussCoil
        self.shape_indep_list.append(Poly_GaussCoil)
        
        from sans.models.PolymerExclVolume import PolymerExclVolume
        self.shape_indep_list.append(PolymerExclVolume)
        
        from sans.models.PorodModel import PorodModel
        self.shape_indep_list.append(PorodModel )      
        
        from sans.models.RPA10Model import RPA10Model
        self.shape_indep_list.append(RPA10Model)
        self.multi_func_list.append(RPA10Model)
        
        from sans.models.TeubnerStreyModel import TeubnerStreyModel
        self.shape_indep_list.append(TeubnerStreyModel )
        
        from sans.models.TwoLorentzianModel import TwoLorentzianModel
        self.shape_indep_list.append(TwoLorentzianModel )
        
        from sans.models.TwoPowerLawModel import TwoPowerLawModel
        self.shape_indep_list.append(TwoPowerLawModel )
        
        from sans.models.UnifiedPowerRgModel import UnifiedPowerRgModel
        self.shape_indep_list.append(UnifiedPowerRgModel )
        self.multi_func_list.append(UnifiedPowerRgModel)
        
        from sans.models.LineModel import LineModel
        self.shape_indep_list.append(LineModel)
        
        from sans.models.ReflectivityModel import ReflectivityModel
        self.multi_func_list.append(ReflectivityModel)
        
        from sans.models.ReflectivityIIModel import ReflectivityIIModel
        self.multi_func_list.append(ReflectivityIIModel)
        
        #Looking for plugins
        self.plugins = findModels()
        self._get_multifunc_models()
        self.plugins.append(ReflectivityModel)
        self.plugins.append(ReflectivityIIModel)
        return 0

    def get_model_list(self):    
        """ 
        :return: dictionary of models for fitpanel use 
        
        """
        self._getModelList()
        self.model_combobox.set_list("Shapes", self.shape_list)
        self.model_combobox.set_list("Shape-Independent", self.shape_indep_list)
        self.model_combobox.set_list("Structure Factors", self.struct_list)
        self.model_combobox.set_list("Customized Models", self.plugins)
        self.model_combobox.set_list("P(Q)*S(Q)", self.multiplication_factor)
        self.model_combobox.set_list("multiplication", self.multiplication_factor)
        self.model_combobox.set_list("Multi-Functions", self.multi_func_list)
        return self.model_combobox
        
    def _get_multifunc_models(self):
        """
        Get the multifunctional models
        """
        for item in self.plugins:
            try:
                # check the multiplicity if any
                if item.multiplicity_info[0] > 1:
                    self.multi_func_list.append(item)
            except:
                # pass to other items
                pass