Changeset 9d93c37 in sasview for src/sas/sasgui/perspectives/fitting

Timestamp:

Apr 6, 2017 6:55:33 PM (8 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, costrafo411, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

87a8a78

Parents:

5e2f36c

Message:

added Combind Batch Fitting instructions — need to tie to HELP button
next. Affects ticket #597

File:

• src/sas/sasgui/perspectives/fitting/media/fitting_help.rst (modified) (1 diff)

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

@@ -636 +636 @@
 
      Example: radius [2 : 5] , radius [10 : 25]
-
-.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
-
-.. note::  This help document was last changed by Steve King, 10Oct2016
+     
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+Combined Batch Fit Mode
+-----------------------
+
+Batch mode does not allow for multiple models.  In other words in batch mode
+all the data sets must be fit with single model and set of parameter.  At times
+there may be a shape change occuring in the series that requires changing the
+model part way through the series.  In this case set up two batch fit pages
+following the instructions in :ref:`Batch Fit Mode`.  However *be careful!* each
+time a batch fit panel runs fit it will overwrite the table of values.
+
+However there may be occassion when one wants to run these two (or more) batch
+fits and then plot one of the common parameters (e.g. radius of shere and
+eventually cylinder).  In this case the Combined Batch Fit can be used.
+Similarly to the Simultaneous Fit page a new page will appear.  In this case,
+instead of a check box for each fitpage model there will be a check box for each
+batchpage.  Clicking the Fit button will run each batch fit *in sequence*. 
+
+.. image:: combine_batch_page.png
+
+The batch table will then pop up at the end as before with the following
+caveats:
+
+.. note::
+   The order matters.  The parameters in the table will be taken from the model
+   used in the first batch page of the list.  Any parameters from the
+   second and on batch pages that have the same name as a parameter in the first
+   will show up allowing for plotting of that parameter across the models.
+.. note::
+   a corralary of the above is that currently models created as a sum|multiply
+   model will not work as desired because the generated model parameters have a
+   p#_ appended to the beginning and thus radius and p1_radius will not be
+   recognized as the same parameter.
+   
+.. image:: combine_batch_grid.png
+
+In this case the series is a time series.  Unfortunately the time is not listed
+in the file but the file name contains the information.  A column can be added
+manually, in this case called time.  Clicking on the top of a column will select
+it. Clicking next on the Add button next to the x or y row will add the cell
+information to use in a plot.  The axis labels will be automatically populated
+from the top row information.  Units can be specified as well using text and a
+subset of in line Latex.  Once this is set up, in this case using the peak
+position from the two different models for the y axis and time on the x axis,
+one clicks the Plot button.  
+
+.. image:: combine_batch_plot.png
+
+Note the discontinuity in the peak position.  This
+is due to the fact that the Guassian fit is actually pretty bad and is not
+actually finding the peak.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Paul Butler, 06April2017