Changeset f485ba0 in sasview for src/sas/sasgui/perspectives/fitting

Timestamp:

Sep 15, 2017 10:45:36 AM (7 years ago)

Author:

smk78

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, costrafo411, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

203669a

Parents:

c6a298c

Message:

Updated fitting_help.rst amd plugin.rst in light of work on #767 & #861

Location:

src/sas/sasgui/perspectives/fitting/media

Files:

• fitting_help.rst (modified) (2 diffs)
• plugin.rst (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, [-numpy.inf, numpy.inf], 'volume', ''],
+                     ['volfraction', '', 1, [-numpy.inf, numpy.inf], '', ''],
+                                         .
+                                         .
+
+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 +237 @@
 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 = 'My Plugin Model'
+     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 (+ - * /) 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.
+
+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!)
+
+Also see :ref:`Adding_your_own_models`.
 
 Overview