Changeset 6d62b7f in sasview for src/sas/sasgui/perspectives/fitting

Timestamp:

Sep 17, 2017 11:52:57 PM (7 years ago)

Author:

butler

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:

13374be

Parents:

ae69c690 (diff), cfd27dd (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.

Message:

Merge remote-tracking branch 'origin/master' into 4_1_issues

Location:

src/sas/sasgui/perspectives/fitting

Files:

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

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

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

@@ -1236 +1236 @@
             wx.PostEvent(self.parent, new_event)
             # update list of plugins if new plugin is available
-            custom_model = CUSTOM_MODEL
             mod_cat = self.categorybox.GetStringSelection()
-            if mod_cat == custom_model:
+            if mod_cat == CUSTOM_MODEL:
+                temp_id = self.model.id
                 temp = self.parent.update_model_list()
+                for v in self.parent.model_dictionary.values():
+                    if v.id == temp_id:
+                        self.model = v()
+                        break
                 if temp:
                     self.model_list_box = temp

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

@@ -92 +92 @@
             # state must be cloned
             state = page.get_state().clone()
-            if data is not None or page.model is not None:
+            # data_list only populated with real data
+            # Fake object in data from page.get_data() if model is selected
+            if len(page.data_list) is not 0 and page.model is not None:
                 new_doc = self._manager.state_reader.write_toXML(data,
                                                                  state,
                                                                  batch_state)
+                # Fit #2 through #n are append to first fit
                 if doc is not None and hasattr(doc, "firstChild"):
-                    child = new_doc.firstChild.firstChild
-                    doc.firstChild.appendChild(child)
+                    # Only append if properly formed new_doc
+                    if new_doc is not None and hasattr(new_doc, "firstChild"):
+                        child = new_doc.firstChild.firstChild
+                        doc.firstChild.appendChild(child)
+                # First fit defines the main document
                 else:
                     doc = new_doc
@@ -395 +401 @@
                 temp_data = page.get_data()
                 if temp_data is not None and temp_data.id in data:
-                    self.SetSelection(pos)
-                    self.on_close_page(event=None)
-                    temp = self.GetSelection()
-                    self.DeletePage(temp)
+                    self.close_page_with_data(temp_data)
             if self.sim_page is not None:
                 if len(self.sim_page.model_list) == 0:
@@ -404 +407 @@
                     self.SetSelection(pos)
                     self.on_close_page(event=None)
-                    temp = self.GetSelection()
-                    self.DeletePage(temp)
+                    self.DeletePage(pos)
                     self.sim_page = None
                     self.batch_on = False

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

@@ -20 +20 @@
 from sas.sasgui.guiframe.CategoryInstaller import CategoryInstaller
 from sasmodels.sasview_model import load_custom_model, load_standard_models
+from sas.sasgui.perspectives.fitting.fitpage import CUSTOM_MODEL
 
 logger = logging.getLogger(__name__)
@@ -265 +266 @@
         temp = {}
         if self.is_changed():
-            return  _find_models()
+            temp =  _find_models()
+            self.last_time_dir_modified = time.time()
+            return temp
         logger.info("plugin model : %s" % str(temp))
         return temp
@@ -312 +315 @@
         if os.path.isdir(plugin_dir):
             temp = os.path.getmtime(plugin_dir)
-            if  self.last_time_dir_modified != temp:
+            if  self.last_time_dir_modified < temp:
                 is_modified = True
                 self.last_time_dir_modified = temp
@@ -323 +326 @@
         new models were added else return empty dictionary
         """
+        self.plugins = []
         new_plugins = self.findModels()
-        if len(new_plugins) > 0:
-            for name, plug in  new_plugins.iteritems():
-                if name not in self.stored_plugins.keys():
-                    self.stored_plugins[name] = plug
-                    self.plugins.append(plug)
-                    self.model_dictionary[name] = plug
-            self.model_combobox.set_list("Plugin Models", self.plugins)
+        if new_plugins:
+            for name, plug in  new_plugins.items():
+                self.stored_plugins[name] = plug
+                self.plugins.append(plug)
+                self.model_dictionary[name] = plug
+            self.model_combobox.set_list(CUSTOM_MODEL, self.plugins)
             return self.model_combobox.get_list()
         else:

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

@@ -617 +617 @@
             value = ""
             content = line.split(":")
+            if line == '' or len(content) == 1:
+                continue
             name = content[0]
             try: