Changes in / [4688acf:b2964ef] in sasview

Location:

src/sas

Files:

• sasgui/perspectives/fitting/media/fitting_help.rst (modified) (4 diffs)
• sasgui/perspectives/fitting/media/fitting_sq.rst (deleted)
• sasgui/perspectives/fitting/media/p_and_s_buttons.png (added)
• sasgui/perspectives/fitting/media/p_and_s_buttons_parameters.png (added)
• sasgui/perspectives/fitting/media/p_and_s_sum_model.png (added)
• sasgui/perspectives/fitting/media/p_and_s_sum_model_parameters.png (added)
• sasview/test/1d_data/AUSANS_run3_2_no_buffer.ABS (added)
• sasview/test/1d_data/AUSANS_run4_1_with_buffer.ABS (added)
• sasview/test/README.txt (modified) (1 diff)

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

@@ -42 +42 @@
 *  *Ellipsoid* - ellipsoidal shapes (oblate,prolate, core shell, etc)
 *  *Parellelepiped* - as the name implies
-*  *Sphere* - sheroidal shapes (sphere, core multishell, vesicle, etc)
+*  *Sphere* - spheroidal shapes (sphere, core multishell, vesicle, etc)
 *  *Lamellae* - lamellar shapes (lamellar, core shell lamellar, stacked
    lamellar, etc)
@@ -61 +61 @@
 on the *Description* button to the right.
 
+Product Models
+^^^^^^^^^^^^^^
+
+S(Q) models can be combined with many models in the other categories to
+generate what SasView calls "product models". The combination can be done by
+one of two methods, but how they behave is slightly different.
+
+The first, most straightforward, method is simply to use the S(Q) drop-down in
+the FitPage:
+
+.. figure:: p_and_s_buttons.png
+
+This example would then generate a product model with the following parameters:
+
+.. figure:: p_and_s_buttons_parameters.png
+
+The other method is to use the :ref:`Sum|Multi(p1,p2)` tool under Fitting >
+Plugin Model Operations:
+
+.. figure:: p_and_s_sum_model.png
+
+This creates a product model with the following parameters:
+
+.. figure:: p_and_s_sum_model_parameters.png
+
+As can be seen, the second method has produced a product model with an extra
+parameter: *radius_effective*. This is the radial distance determining the
+range of the $S(Q)$ interaction and may, or may not, be the same as the
+*radius*, in this example, depending on the concentration of the system. In
+other systems, *radius_effective* may depend on the particle form (shape).
+
+See :ref:`Product_Models` for more information.
+
 Show 1D/2D
 ^^^^^^^^^^
@@ -119 +152 @@
 
 For a complete list of all the library models available in SasView, see
-the `Model Documentation <../../../index.html>`_ .
+the `Model Documentation <../../../sasgui/perspectives/fitting/models/index.html>`_ .
 
 It is also possible to add your own models.
@@ -216 +249 @@
 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):
 
 Sum|Multi(p1,p2)

src/sas/sasview/test/README.txt

@@ -1 @@
-Test data sets are included as a convenience to our users. The data sets are organized based on their data structure; 1D data (ie, I(Q)), 2D data (ie, I(Qx,Qy)), coordinate data (eg, PDB files), image data (eg, TIFF files), SasView saved states, SESANS data, and data in formats that are not yet implemented but which are in the works for future releases.
+Test data sets are included as a convenience to our users. The data sets are
+organized based on their data structure; 1D data (ie, I(Q)), 2D data
+(ie, I(Qx,Qy)), coordinate data (eg, PDB files), image data
+(eg, TIFF files), SasView saved states, SESANS data, and data in formats that
+are not yet implemented but which are in the works for future releases.
 
-1D data sets EITHER a) have at least two columns of data with I(abs. units) on the y-axis and Q on the x-axis, OR b) have I and Q in separate files. Data in the latter format (/convertible_files) need to be converted to a single file format with the File Converter tool before SasView will analyse them.
+1D data sets EITHER a) have at least two columns of data with I(abs. units) on
+the y-axis and Q on the x-axis, OR b) have I and Q in separate files. Data in
+the latter format (/convertible_files) need to be converted to a single file
+format with the File Converter tool before SasView will analyse them.
 
-2D data sets are data sets that give the deduced intensity for each detector pixel. Depending on the file extension, uncertainty and metadata may also be available.
+2D data sets are data sets that give the deduced intensity for each detector
+pixel. Depending on the file extension, uncertainty and metadata may also be
+available.
 
-Coordinate data sets are designed to be read by the Generic Scattering Calculator tool.
+Coordinate data sets are designed to be read by the Generic Scattering
+Calculator tool.
 
 Image data sets are designed to be read by the Image Viewer tool.
 
-Save states are projects and analyses saved by the SASVIEW program. A single analysis file contains the data and parameters for a single fit (.fit), p(r) inversion (.pr), or invariant calculation (.inv). A project file (.svs) contains the results for every active analysis.
+Save states are projects and analyses saved by the SASVIEW program. A single
+analysis file contains the data and parameters for a single fit (.fit), p(r)
+inversion (.pr), or invariant calculation (.inv). A project file (.svs)
+contains the results for every active analysis.
 
-SESANS data sets primarily contain the neutron polarisation as a function of the spin-echo length.
+SESANS data sets primarily contain the neutron polarisation as a function of
+the spin-echo length.