Changeset 66acafe in sasview for src/sas/sasgui/perspectives/fitting

Timestamp:

Sep 19, 2017 9:28:58 AM (7 years ago)

Author:

GitHub <noreply@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

b22e23e

Parents:

8c945ec (diff), 632fda9 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

git-author:

Paul Butler <butlerpd@…> (09/19/17 09:28:58)

git-committer:

GitHub <noreply@…> (09/19/17 09:28:58)

Message:

Merge pull request #104 from lewisodriscoll/ticket-861

Ticket 861

Location:

src/sas/sasgui/perspectives/fitting

Files:

• basepage.py (modified) (1 diff)
• fitpage.py (modified) (1 diff)
• fitting.py (modified) (1 diff)
• models.py (modified) (4 diffs)
• fitpanel.py (modified) (1 diff)
• media/fitting_help.rst (modified) (2 diffs)
• media/plugin.rst (modified) (1 diff)

src/sas/sasgui/perspectives/fitting/basepage.py

@@ -1841 +1841 @@
             if models.name != "NoStructure":
                 mlist.append((models.name, models))
-
         # Sort the models
         mlist_sorted = sorted(mlist)

src/sas/sasgui/perspectives/fitting/fitpage.py

@@ -1156 +1156 @@
                 copy_flag = self.get_copy_params()
                 is_poly_enabled = self.enable_disp.GetValue()
-
-        self._on_select_model_helper()
+        try:
+            self._on_select_model_helper()
+        except Exception as e:
+            evt = StatusEvent(status=e.message, info="error")
+            wx.PostEvent(self._manager.parent, evt)
+            # Set S(Q) to None
+            self.structurebox.SetSelection(0)
+            self._on_select_model()
+            return
         self.set_model_param_sizer(self.model)
         if self.model is None:

src/sas/sasgui/perspectives/fitting/fitting.py

@@ -357 +357 @@
                             else:
                                 page.formfactorbox.SetLabel(current_val)
+                        if hasattr(page, 'structurebox'):
+                            selected_name = page.structurebox.GetStringSelection()
+
+                            page.structurebox.Clear()
+                            page.initialize_combox()
+
+                            index = page.structurebox.FindString(selected_name)
+                            if index == -1:
+                                index = 0
+                            page.structurebox.SetSelection(index)
+                            page._on_select_model()
         except:
             logger.error("update_custom_combo: %s", sys.exc_value)

src/sas/sasgui/perspectives/fitting/models.py

@@ -14 +14 @@
 import py_compile
 import shutil
+from copy import copy
 # Explicitly import from the pluginmodel module so that py2exe
 # places it in the distribution. The Model1DPlugin class is used
@@ -278 +279 @@
         """
 
-        # regular model names only
+        # Regular model names only
         self.model_name_list = []
 
-        #Build list automagically from sasmodels package
+        # Build list automagically from sasmodels package
         for model in load_standard_models():
             self.model_dictionary[model.name] = model
@@ -293 +294 @@
                 self.model_name_list.append(model.name)
 
-        #Looking for plugins
+        # Looking for plugins
         self.stored_plugins = self.findModels()
         self.plugins = self.stored_plugins.values()
         for name, plug in self.stored_plugins.iteritems():
             self.model_dictionary[name] = plug
+            # TODO: Remove 'hasattr' statements when old style plugin models
+            # are no longer supported. All sasmodels models will have
+            # the required attributes.
+            if hasattr(plug, 'is_structure_factor') and plug.is_structure_factor:
+                self.struct_list.append(plug)
+                self.plugins.remove(plug)
+            elif hasattr(plug, 'is_form_factor') and plug.is_form_factor:
+                self.multiplication_factor.append(plug)
+            if hasattr(plug, 'is_multiplicity_model') and plug.is_multiplicity_model:
+                self.multi_func_list.append(plug)
 
         self._get_multifunc_models()
@@ -340 +351 @@
         """
         self.plugins = []
-        new_plugins = _find_models()
-        for name, plug in  new_plugins.iteritems():
-            for stored_name, stored_plug in self.stored_plugins.iteritems():
-                if name == stored_name:
-                    del self.stored_plugins[name]
-                    del self.model_dictionary[name]
-                    break
+        self.stored_plugins = _find_models()
+        structure_names = [model.name for model in self.struct_list]
+        form_names = [model.name for model in self.multiplication_factor]
+
+        # Remove all plugin structure factors and form factors
+        for name in copy(structure_names):
+            if '[plug-in]' in name:
+                i = structure_names.index(name)
+                del self.struct_list[i]
+                structure_names.remove(name)
+        for name in copy(form_names):
+            if '[plug-in]' in name:
+                i = form_names.index(name)
+                del self.multiplication_factor[i]
+                form_names.remove(name)
+
+        # Add new plugin structure factors and form factors
+        for name, plug in self.stored_plugins.iteritems():
+            if plug.is_structure_factor:
+                if name in structure_names:
+                    # Delete the old model from self.struct list
+                    i = structure_names.index(name)
+                    del self.struct_list[i]
+                # Add the new model to self.struct_list
+                self.struct_list.append(plug)
+            elif plug.is_form_factor:
+                if name in form_names:
+                    # Delete the old model from self.multiplication_factor
+                    i = form_names.index(name)
+                    del self.multiplication_factor[i]
+                # Add the new model to self.multiplication_factor
+                self.multiplication_factor.append(plug)
+
+            # Add references to the updated model
             self.stored_plugins[name] = plug
-            self.plugins.append(plug)
+            if not plug.is_structure_factor:
+                # Don't show S(Q) models in the 'Plugin Models' dropdown
+                self.plugins.append(plug)
             self.model_dictionary[name] = plug
 
         self.model_combobox.reset_list("Plugin Models", self.plugins)
+        self.model_combobox.reset_list("Structure Factors", self.struct_list)
+        self.model_combobox.reset_list("P(Q)*S(Q)", self.multiplication_factor)
+
         return self.model_combobox.get_list()
 

src/sas/sasgui/perspectives/fitting/fitpanel.py

@@ -501 +501 @@
             if data is None:
                 return None
+        focused_page = self.GetPage(self.GetSelection())
         for page in self.opened_pages.values():
             # check if the selected data existing in the fitpanel
             pos = self.GetPageIndex(page)
             if not check_data_validity(page.get_data()) and not page.batch_on:
+                if page.model is not None and page != focused_page:
+                    # Page has an active theory and is in background - don't
+                    # send data here.
+                    continue
                 # make sure data get placed in 1D empty tab if data is 1D
                 # else data get place on 2D tab empty tab

src/sas/sasgui/perspectives/fitting/media/fitting_help.rst

@@ -195 +195 @@
 the :ref:`Advanced_Plugin_Editor` .
 
+**SasView version 4.2** made it possible to specify whether a plugin created with 
+the *New Plugin Model* dialog is actually a form factor P(Q) or a structure factor 
+S(Q). To do this, simply add one or other of the following lines under the *import* 
+statements.
+
+For a form factor::
+
+     form_factor = True
+         
+or for a structure factor::
+
+     structure_factor = True
+         
+If the plugin is a structure factor it is *also* necessary to add two variables to 
+the parameter list::
+
+     parameters = [ 
+                     ['radius_effective', '', 1, [0.0, numpy.inf], 'volume', ''],
+                     ['volfraction', '', 1, [0.0, 1.0], '', ''],
+                     [...],
+
+and to the declarations of the functions Iq and Iqxy:::
+
+     def Iq(x , radius_effective, volfraction, ...):
+
+     def Iqxy(x, y, radius_effective, volfraction, ...):
+
+Such a plugin should then be available in the S(Q) drop-down box on a FitPage (once 
+a P(Q) model has been selected).
+
 Sum|Multi(p1,p2)
 ^^^^^^^^^^^^^^^^
@@ -206 +236 @@
 or::
 
-     Plugin Model = scale_factor * model_1 /* model_2 + background
+     Plugin Model = scale_factor * (model1 * model2) + background
 
 In the *Easy Sum/Multi Editor* give the new model a function name and brief
 description (to appear under the *Details* button on the *FitPage*). Then select
 two existing models, as p1 and p2, and the required operator, '+' or '*' between
-them. Finally, click the *Apply* button to generate the model and then click *Close*.
-
-Any changes to a plugin model generated in this way only become effective *after* it is re-selected from the model drop-down menu on the FitPage.
+them. Finally, click the *Apply* button to generate and test the model and then click *Close*.
+
+Any changes to a plugin model generated in this way only become effective *after* it is re-selected 
+from the plugin models drop-down menu on the FitPage. If the model is not listed you can force a 
+recompilation of the plugins by selecting *Fitting* > *Plugin Model Operations* > *Load Plugin Models*.
+
+**SasView version 4.2** introduced a much simplified and more extensible structure for plugin models 
+generated through the Easy Sum/Multi Editor. For example, the code for a combination of a sphere model 
+with a power law model now looks like this::
+
+     from sasmodels.core import load_model_info
+     from sasmodels.sasview_model import make_model_from_info
+     
+     model_info = load_model_info('sphere+power_law')
+     model_info.name = 'MyPluginModel'
+     model_info.description = 'sphere + power_law'
+     Model = make_model_from_info(model_info)
+
+To change the models or operators contributing to this plugin it is only necessary to edit the string 
+in the brackets after *load_model_info*, though it would also be a good idea to update the model name 
+and description too!!!
+
+The model specification string can handle multiple models and combinations of operators (+ or *) which 
+are processed according to normal conventions. Thus 'model1+model2*model3' would be valid and would 
+multiply model2 by model3 before adding model1. In this example, parameters in the *FitPage* would be 
+prefixed A (for model2), B (for model3) and C (for model1). Whilst this might appear a little 
+confusing, unless you were creating a plugin model from multiple instances of the same model the parameter 
+assignments ought to be obvious when you load the plugin.
+
+If you need to include another plugin model in the model specification string, just prefix the name of 
+that model with *custom*. For instance::
+
+     sphere+custom.MyPluginModel
+
+To create a P(Q)*\S(Q) model use the @ symbol instead of * like this::
+
+     sphere@hardsphere
+     
+This streamlined approach to building complex plugin models from existing library models, or models 
+available on the *Model Marketplace*, also permits the creation of P(Q)*\S(Q) plugin models, something 
+that was not possible in earlier versions of SasView. 
 
 .. _Advanced_Plugin_Editor:

src/sas/sasgui/perspectives/fitting/media/plugin.rst

@@ -18 +18 @@
 * By writing a model from scratch outside of SasView (only recommended for
   code monkeys!)
+
+**What follows below is quite technical. If you just want a helping hand to get 
+started creating your own models see** :ref:`Adding_your_own_models`.
 
 Overview