| 1 | #TODO: add comments to document this module |
|---|
| 2 | #TODO: clean-up the exception handling. |
|---|
| 3 | #TODO: clean-up existing comments/documentation. |
|---|
| 4 | # For example, the _getModelList method advertises |
|---|
| 5 | # an 'id' parameter that is not part of the method's signature. |
|---|
| 6 | # It also advertises an ID as return value but it always returns zero. |
|---|
| 7 | #TODO: clean-up the FractalAbsModel and PowerLawAbsModel menu items. Those |
|---|
| 8 | # model definitions do not belong here. They belong with the rest of the |
|---|
| 9 | # models. |
|---|
| 10 | |
|---|
| 11 | import wx |
|---|
| 12 | import wx.lib.newevent |
|---|
| 13 | import imp |
|---|
| 14 | import os,sys,math |
|---|
| 15 | import os.path |
|---|
| 16 | |
|---|
| 17 | (ModelEvent, EVT_MODEL) = wx.lib.newevent.NewEvent() |
|---|
| 18 | |
|---|
| 19 | # Time is needed by the log method |
|---|
| 20 | import time |
|---|
| 21 | |
|---|
| 22 | # Explicitly import from the pluginmodel module so that py2exe |
|---|
| 23 | # places it in the distribution. The Model1DPlugin class is used |
|---|
| 24 | # as the base class of plug-in models. |
|---|
| 25 | from sans.models.pluginmodel import Model1DPlugin |
|---|
| 26 | |
|---|
| 27 | def log(message): |
|---|
| 28 | out = open("plugins.log", 'a') |
|---|
| 29 | out.write("%10g: %s\n" % (time.clock(), message)) |
|---|
| 30 | out.close() |
|---|
| 31 | |
|---|
| 32 | def findModels(): |
|---|
| 33 | log("looking for models in: %s/plugins" % os.getcwd()) |
|---|
| 34 | if os.path.isdir('plugins'): |
|---|
| 35 | return _findModels('plugins') |
|---|
| 36 | return [] |
|---|
| 37 | |
|---|
| 38 | def _findModels(dir): |
|---|
| 39 | # List of plugin objects |
|---|
| 40 | plugins = [] |
|---|
| 41 | # Go through files in plug-in directory |
|---|
| 42 | try: |
|---|
| 43 | list = os.listdir(dir) |
|---|
| 44 | for item in list: |
|---|
| 45 | toks = os.path.splitext(os.path.basename(item)) |
|---|
| 46 | if toks[1]=='.py' and not toks[0]=='__init__': |
|---|
| 47 | name = toks[0] |
|---|
| 48 | |
|---|
| 49 | path = [os.path.abspath(dir)] |
|---|
| 50 | file = None |
|---|
| 51 | try: |
|---|
| 52 | (file, path, info) = imp.find_module(name, path) |
|---|
| 53 | module = imp.load_module( name, file, item, info ) |
|---|
| 54 | if hasattr(module, "Model"): |
|---|
| 55 | try: |
|---|
| 56 | plugins.append(module.Model) |
|---|
| 57 | except: |
|---|
| 58 | log("Error accessing Model in %s\n %s" % (name, sys.exc_value)) |
|---|
| 59 | except: |
|---|
| 60 | log("Error accessing Model in %s\n %s" % (name, sys.exc_value)) |
|---|
| 61 | finally: |
|---|
| 62 | |
|---|
| 63 | if not file==None: |
|---|
| 64 | file.close() |
|---|
| 65 | except: |
|---|
| 66 | # Don't deal with bad plug-in imports. Just skip. |
|---|
| 67 | pass |
|---|
| 68 | return plugins |
|---|
| 69 | |
|---|
| 70 | class ModelList(object): |
|---|
| 71 | """ |
|---|
| 72 | Contains dictionary of model and their type |
|---|
| 73 | """ |
|---|
| 74 | def __init__(self): |
|---|
| 75 | self.mydict={} |
|---|
| 76 | |
|---|
| 77 | def set_list(self, name, mylist): |
|---|
| 78 | """ |
|---|
| 79 | @param name: the type of the list |
|---|
| 80 | @param mylist: the list to add |
|---|
| 81 | """ |
|---|
| 82 | if name not in self.mydict.keys(): |
|---|
| 83 | self.mydict[name] = mylist |
|---|
| 84 | |
|---|
| 85 | |
|---|
| 86 | def get_list(self): |
|---|
| 87 | """ |
|---|
| 88 | return all the list stored in a dictionary object |
|---|
| 89 | """ |
|---|
| 90 | return self.mydict |
|---|
| 91 | |
|---|
| 92 | class ModelManager: |
|---|
| 93 | ## external dict for models |
|---|
| 94 | model_combobox = ModelList() |
|---|
| 95 | ## Dictionary of form models |
|---|
| 96 | form_factor_dict = {} |
|---|
| 97 | ## dictionary of other |
|---|
| 98 | struct_factor_dict = {} |
|---|
| 99 | ##list of form factors |
|---|
| 100 | shape_list =[] |
|---|
| 101 | ## independent shape model list |
|---|
| 102 | shape_indep_list = [] |
|---|
| 103 | ##list of structure factors |
|---|
| 104 | struct_list= [] |
|---|
| 105 | ##list of model allowing multiplication |
|---|
| 106 | multiplication_factor=[] |
|---|
| 107 | ## list of added models |
|---|
| 108 | plugins=[] |
|---|
| 109 | ## Event owner (guiframe) |
|---|
| 110 | event_owner = None |
|---|
| 111 | |
|---|
| 112 | def _getModelList(self): |
|---|
| 113 | """ |
|---|
| 114 | List of models we want to make available by default |
|---|
| 115 | for this application |
|---|
| 116 | |
|---|
| 117 | @param id: first event ID to register the menu events with |
|---|
| 118 | @return: the next free event ID following the new menu events |
|---|
| 119 | """ |
|---|
| 120 | ## form factor |
|---|
| 121 | from sans.models.SphereModel import SphereModel |
|---|
| 122 | self.shape_list.append(SphereModel) |
|---|
| 123 | self.multiplication_factor.append(SphereModel) |
|---|
| 124 | |
|---|
| 125 | from sans.models.CylinderModel import CylinderModel |
|---|
| 126 | self.shape_list.append(CylinderModel) |
|---|
| 127 | self.multiplication_factor.append(CylinderModel) |
|---|
| 128 | |
|---|
| 129 | from sans.models.ParallelepipedModel import ParallelepipedModel |
|---|
| 130 | self.shape_list.append(ParallelepipedModel) |
|---|
| 131 | self.multiplication_factor.append(ParallelepipedModel) |
|---|
| 132 | |
|---|
| 133 | from sans.models.CoreShellModel import CoreShellModel |
|---|
| 134 | self.shape_list.append(CoreShellModel) |
|---|
| 135 | |
|---|
| 136 | from sans.models.CoreShellCylinderModel import CoreShellCylinderModel |
|---|
| 137 | self.shape_list.append(CoreShellCylinderModel) |
|---|
| 138 | |
|---|
| 139 | from sans.models.EllipticalCylinderModel import EllipticalCylinderModel |
|---|
| 140 | self.shape_list.append(EllipticalCylinderModel) |
|---|
| 141 | |
|---|
| 142 | from sans.models.EllipsoidModel import EllipsoidModel |
|---|
| 143 | self.shape_list.append(EllipsoidModel) |
|---|
| 144 | self.multiplication_factor.append(EllipsoidModel) |
|---|
| 145 | |
|---|
| 146 | from sans.models.TriaxialEllipsoidModel import TriaxialEllipsoidModel |
|---|
| 147 | self.shape_list.append(TriaxialEllipsoidModel) |
|---|
| 148 | |
|---|
| 149 | from sans.models.FlexibleCylinderModel import FlexibleCylinderModel |
|---|
| 150 | self.shape_list.append(FlexibleCylinderModel) |
|---|
| 151 | |
|---|
| 152 | from sans.models.StackedDisksModel import StackedDisksModel |
|---|
| 153 | self.shape_list.append(StackedDisksModel) |
|---|
| 154 | |
|---|
| 155 | from sans.models.LamellarModel import LamellarModel |
|---|
| 156 | self.shape_list.append(LamellarModel) |
|---|
| 157 | |
|---|
| 158 | from sans.models.LamellarFFHGModel import LamellarFFHGModel |
|---|
| 159 | self.shape_list.append(LamellarFFHGModel) |
|---|
| 160 | |
|---|
| 161 | from sans.models.LamellarPSModel import LamellarPSModel |
|---|
| 162 | self.shape_list.append(LamellarPSModel) |
|---|
| 163 | |
|---|
| 164 | from sans.models.LamellarPSHGModel import LamellarPSHGModel |
|---|
| 165 | self.shape_list.append(LamellarPSHGModel) |
|---|
| 166 | |
|---|
| 167 | from sans.models.OblateModel import OblateModel |
|---|
| 168 | self.shape_list.append(OblateModel) |
|---|
| 169 | |
|---|
| 170 | from sans.models.ProlateModel import ProlateModel |
|---|
| 171 | self.shape_list.append(ProlateModel) |
|---|
| 172 | |
|---|
| 173 | ## Structure factor |
|---|
| 174 | from sans.models.SquareWellStructure import SquareWellStructure |
|---|
| 175 | self.struct_list.append(SquareWellStructure) |
|---|
| 176 | |
|---|
| 177 | from sans.models.HardsphereStructure import HardsphereStructure |
|---|
| 178 | self.struct_list.append(HardsphereStructure) |
|---|
| 179 | |
|---|
| 180 | from sans.models.StickyHSStructure import StickyHSStructure |
|---|
| 181 | self.struct_list.append(StickyHSStructure) |
|---|
| 182 | |
|---|
| 183 | from sans.models.HayterMSAStructure import HayterMSAStructure |
|---|
| 184 | self.struct_list.append(HayterMSAStructure) |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | ##shape-independent models |
|---|
| 188 | from sans.models.BEPolyelectrolyte import BEPolyelectrolyte |
|---|
| 189 | self.shape_indep_list.append(BEPolyelectrolyte ) |
|---|
| 190 | self.form_factor_dict[str(wx.NewId())] = [SphereModel] |
|---|
| 191 | from sans.models.DABModel import DABModel |
|---|
| 192 | self.shape_indep_list.append(DABModel ) |
|---|
| 193 | |
|---|
| 194 | from sans.models.GuinierModel import GuinierModel |
|---|
| 195 | self.shape_indep_list.append(GuinierModel ) |
|---|
| 196 | |
|---|
| 197 | from sans.models.DebyeModel import DebyeModel |
|---|
| 198 | self.shape_indep_list.append(DebyeModel ) |
|---|
| 199 | |
|---|
| 200 | from sans.models.PorodModel import PorodModel |
|---|
| 201 | self.shape_indep_list.append(PorodModel ) |
|---|
| 202 | |
|---|
| 203 | from sans.models.LineModel import LineModel |
|---|
| 204 | self.shape_indep_list.append(LineModel) |
|---|
| 205 | |
|---|
| 206 | from sans.models.FractalModel import FractalModel |
|---|
| 207 | class FractalAbsModel(FractalModel): |
|---|
| 208 | def _Fractal(self, x): |
|---|
| 209 | return FractalModel._Fractal(self, math.fabs(x)) |
|---|
| 210 | self.shape_indep_list.append(FractalAbsModel) |
|---|
| 211 | |
|---|
| 212 | from sans.models.LorentzModel import LorentzModel |
|---|
| 213 | self.shape_indep_list.append( LorentzModel) |
|---|
| 214 | |
|---|
| 215 | from sans.models.PowerLawModel import PowerLawModel |
|---|
| 216 | class PowerLawAbsModel(PowerLawModel): |
|---|
| 217 | def _PowerLaw(self, x): |
|---|
| 218 | try: |
|---|
| 219 | return PowerLawModel._PowerLaw(self, math.fabs(x)) |
|---|
| 220 | except: |
|---|
| 221 | print sys.exc_value |
|---|
| 222 | self.shape_indep_list.append( PowerLawAbsModel ) |
|---|
| 223 | from sans.models.TeubnerStreyModel import TeubnerStreyModel |
|---|
| 224 | self.shape_indep_list.append(TeubnerStreyModel ) |
|---|
| 225 | |
|---|
| 226 | #Looking for plugins |
|---|
| 227 | self.plugins = findModels() |
|---|
| 228 | |
|---|
| 229 | return 0 |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | def populate_menu(self, modelmenu, event_owner): |
|---|
| 233 | """ |
|---|
| 234 | Populate a menu with our models |
|---|
| 235 | |
|---|
| 236 | @param id: first menu event ID to use when binding the menu events |
|---|
| 237 | @param modelmenu: wx.Menu object to populate |
|---|
| 238 | @param event_owner: wx object to bind the menu events to |
|---|
| 239 | @return: the next free event ID following the new menu events |
|---|
| 240 | """ |
|---|
| 241 | ## Fill model lists |
|---|
| 242 | self._getModelList() |
|---|
| 243 | ## store reference to model menu of guiframe |
|---|
| 244 | self.modelmenu = modelmenu |
|---|
| 245 | ## guiframe reference |
|---|
| 246 | self.event_owner = event_owner |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | shape_submenu = wx.Menu() |
|---|
| 250 | shape_indep_submenu = wx.Menu() |
|---|
| 251 | structure_factor = wx.Menu() |
|---|
| 252 | added_models = wx.Menu() |
|---|
| 253 | multip_models = wx.Menu() |
|---|
| 254 | ## create menu with shape |
|---|
| 255 | self._fill_simple_menu( menuinfo = ["Shapes",shape_submenu," simple shape"], |
|---|
| 256 | list1 = self.shape_list ) |
|---|
| 257 | |
|---|
| 258 | self._fill_simple_menu( menuinfo = ["Shape-Independent",shape_indep_submenu, |
|---|
| 259 | "List of shape-independent models"], |
|---|
| 260 | list1 = self.shape_indep_list ) |
|---|
| 261 | |
|---|
| 262 | self._fill_simple_menu( menuinfo= ["Structure Factors",structure_factor, |
|---|
| 263 | "List of Structure factors models" ], |
|---|
| 264 | list1= self.struct_list ) |
|---|
| 265 | |
|---|
| 266 | self._fill_simple_menu( menuinfo = ["Customized Models", added_models, |
|---|
| 267 | "List of additional models"], |
|---|
| 268 | list1= self.plugins ) |
|---|
| 269 | |
|---|
| 270 | self._fill_menu(menuinfo=["P(Q)*S(Q)",multip_models, |
|---|
| 271 | "mulplication of 2 models"], |
|---|
| 272 | list1 = self.multiplication_factor , |
|---|
| 273 | list2 = self.struct_list) |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | return 0 |
|---|
| 277 | |
|---|
| 278 | def _fill_simple_menu(self,menuinfo, list1): |
|---|
| 279 | """ |
|---|
| 280 | Fill the menu with list item |
|---|
| 281 | @param modelmenu: the menu to fill |
|---|
| 282 | @param menuinfo: submenu item for the first column of this modelmenu |
|---|
| 283 | with info.Should be a list : |
|---|
| 284 | [name(string) , menu(wx.menu), help(string)] |
|---|
| 285 | @param list1: contains item (form factor )to fill modelmenu second column |
|---|
| 286 | """ |
|---|
| 287 | if len(list1)>0: |
|---|
| 288 | self.model_combobox.set_list(menuinfo[0],list1) |
|---|
| 289 | |
|---|
| 290 | for item in list1: |
|---|
| 291 | id = wx.NewId() |
|---|
| 292 | struct_factor=item() |
|---|
| 293 | struct_name = struct_factor.__class__.__name__ |
|---|
| 294 | if hasattr(struct_factor, "name"): |
|---|
| 295 | struct_name = struct_factor.name |
|---|
| 296 | |
|---|
| 297 | menuinfo[1].Append(int(id),struct_name,struct_name) |
|---|
| 298 | if not item in self.struct_factor_dict.itervalues(): |
|---|
| 299 | self.struct_factor_dict[str(id)]= item |
|---|
| 300 | wx.EVT_MENU(self.event_owner, int(id), self._on_model) |
|---|
| 301 | |
|---|
| 302 | id = wx.NewId() |
|---|
| 303 | self.modelmenu.AppendMenu(id, menuinfo[0],menuinfo[1],menuinfo[2]) |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | def _fill_menu(self,menuinfo, list1,list2 ): |
|---|
| 308 | """ |
|---|
| 309 | Fill the menu with list item |
|---|
| 310 | @param menuinfo: submenu item for the first column of this modelmenu |
|---|
| 311 | with info.Should be a list : |
|---|
| 312 | [name(string) , menu(wx.menu), help(string)] |
|---|
| 313 | @param list1: contains item (form factor )to fill modelmenu second column |
|---|
| 314 | @param list2: contains item (Structure factor )to fill modelmenu third column |
|---|
| 315 | """ |
|---|
| 316 | if len(list1)>0: |
|---|
| 317 | self.model_combobox.set_list(menuinfo[0],list1) |
|---|
| 318 | |
|---|
| 319 | for item in list1: |
|---|
| 320 | form_factor= item() |
|---|
| 321 | form_name = form_factor.__class__.__name__ |
|---|
| 322 | if hasattr(form_factor, "name"): |
|---|
| 323 | form_name = form_factor.name |
|---|
| 324 | ### store form factor to return to other users |
|---|
| 325 | newmenu= wx.Menu() |
|---|
| 326 | if len(list2)>0: |
|---|
| 327 | for model in list2: |
|---|
| 328 | id = wx.NewId() |
|---|
| 329 | struct_factor = model() |
|---|
| 330 | name = struct_factor.__class__.__name__ |
|---|
| 331 | if hasattr(struct_factor, "name"): |
|---|
| 332 | name = struct_factor.name |
|---|
| 333 | newmenu.Append(id,name, name) |
|---|
| 334 | wx.EVT_MENU(self.event_owner, int(id), self._on_model) |
|---|
| 335 | ## save form_fact and struct_fact |
|---|
| 336 | self.form_factor_dict[int(id)] = [form_factor,struct_factor] |
|---|
| 337 | |
|---|
| 338 | form_id= wx.NewId() |
|---|
| 339 | menuinfo[1].AppendMenu(int(form_id), form_name,newmenu,menuinfo[2]) |
|---|
| 340 | id=wx.NewId() |
|---|
| 341 | self.modelmenu.AppendMenu(id,menuinfo[0],menuinfo[1], menuinfo[2]) |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | |
|---|
| 345 | |
|---|
| 346 | def _on_model(self, evt): |
|---|
| 347 | """ |
|---|
| 348 | React to a model menu event |
|---|
| 349 | @param event: wx menu event |
|---|
| 350 | """ |
|---|
| 351 | if int(evt.GetId()) in self.form_factor_dict.keys(): |
|---|
| 352 | from sans.models.MultiplicationModel import MultiplicationModel |
|---|
| 353 | model1, model2 = self.form_factor_dict[int(evt.GetId())] |
|---|
| 354 | model = MultiplicationModel(model1, model2) |
|---|
| 355 | |
|---|
| 356 | else: |
|---|
| 357 | model= self.struct_factor_dict[str(evt.GetId())]() |
|---|
| 358 | |
|---|
| 359 | evt = ModelEvent( model= model ) |
|---|
| 360 | wx.PostEvent(self.event_owner, evt) |
|---|
| 361 | |
|---|
| 362 | def get_model_list(self): |
|---|
| 363 | """ @ return dictionary of models for fitpanel use """ |
|---|
| 364 | self.model_combobox.set_list("multiplication", self.multiplication_factor) |
|---|
| 365 | return self.model_combobox |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | |
|---|
| 369 | |
|---|
| 370 | |
|---|
| 371 | |
|---|
