Ignore:
Timestamp:
Sep 10, 2017 11:08:08 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, costrafo411, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
05b0bf6
Parents:
e32c98a
Message:

Rewrite Combine Batch Fit help based on feedback in ticket. Start with
"What it is" and add Method section on how to use including links to
previous detailed descriptions rather than rewrite them.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • TabularUnified src/sas/sasgui/perspectives/fitting/media/fitting_help.rst

    r9d93c37 re6c74e8  
    484484.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    485485 
     486.. _Batch_Fit_Mode: 
     487 
    486488Batch Fit Mode 
    487489-------------- 
     
    642644----------------------- 
    643645 
    644 Batch mode does not allow for multiple models.  In other words in batch mode 
    645 all the data sets must be fit with single model and set of parameter.  At times 
    646 there may be a shape change occuring in the series that requires changing the 
    647 model part way through the series.  In this case set up two batch fit pages 
    648 following the instructions in :ref:`Batch Fit Mode`.  However *be careful!* each 
    649 time a batch fit panel runs fit it will overwrite the table of values. 
    650  
    651 However there may be occassion when one wants to run these two (or more) batch 
    652 fits and then plot one of the common parameters (e.g. radius of shere and 
    653 eventually cylinder).  In this case the Combined Batch Fit can be used. 
    654 Similarly to the Simultaneous Fit page a new page will appear.  In this case, 
    655 instead of a check box for each fitpage model there will be a check box for each 
    656 batchpage.  Clicking the Fit button will run each batch fit *in sequence*.  
     646The purpose of the Combined Batch Fit is to allow running two or more batch 
     647fits in sequence without overwriting the output table of results.  This may be 
     648of interest for example if one is fitting a series of data sets where there is 
     649a shape change occurring in the series that requires changing the model part 
     650way through the series; for example a sphere to rod transition.  Indeed the 
     651regular batch mode does not allow for multiple models and requires all the 
     652files in the series to be fit with single model and set of parameters.  While 
     653it is of course possible to just run part of the series as a batch fit using 
     654model one followed by running another batch fit on the rest of the series with 
     655model two (and/or model three etc), doing so will overwrite the table of 
     656outputs from the previous batch fit(s).  This may not be desirable if one is 
     657interested in comparing the parameters: for example the sphere radius of set 
     658one and the cylinder radius of set 2. 
     659 
     660Method 
     661^^^^^^ 
     662 
     663In order to use the *Combined Batch Fit*, first load all the data needed as 
     664described in :ref:`Loading_data`. Next start up two or more *BatchPage* fits 
     665following the instructions in :ref:`Batch_Fit_Mode` but **DO NOT PRESS FIT**. 
     666At this point the *Combine Batch Fit* menu item under the *Fitting menu* should 
     667be active (if there is one or no *BatchPage* the menu item will be greyed out 
     668and inactive).  Clicking on *Combine Batch Fit* will bring up a new panel, 
     669similar to the *Const & Simult Fit* panel. In this case there will be a 
     670checkbox for each *BatchPage* instead of each *FitPage* that should be included 
     671in the fit.  Once all are selected, click the Fit button on 
     672the *BatchPage* to run each batch fit in *sequence* 
    657673 
    658674.. image:: combine_batch_page.png 
    659675 
    660 The batch table will then pop up at the end as before with the following 
    661 caveats: 
     676The batch table will then pop up at the end as for the case of the simple Batch 
     677Fitting with the following caveats: 
    662678 
    663679.. note:: 
    664680   The order matters.  The parameters in the table will be taken from the model 
    665    used in the first batch page of the list.  Any parameters from the 
    666    second and on batch pages that have the same name as a parameter in the first 
    667    will show up allowing for plotting of that parameter across the models. 
     681   used in the first *BatchPage* of the list.  Any parameters from the 
     682   second and later *BatchPage* s that have the same name as a parameter in the 
     683   first will show up allowing for plotting of that parameter across the 
     684   models. The other parameters will not be available in the grid. 
    668685.. note:: 
    669686   a corralary of the above is that currently models created as a sum|multiply 
     
    674691.. image:: combine_batch_grid.png 
    675692 
    676 In this case the series is a time series.  Unfortunately the time is not listed 
    677 in the file but the file name contains the information.  A column can be added 
    678 manually, in this case called time.  Clicking on the top of a column will select 
    679 it. Clicking next on the Add button next to the x or y row will add the cell 
    680 information to use in a plot.  The axis labels will be automatically populated 
    681 from the top row information.  Units can be specified as well using text and a 
    682 subset of in line Latex.  Once this is set up, in this case using the peak 
    683 position from the two different models for the y axis and time on the x axis, 
    684 one clicks the Plot button.   
     693In the example shown above the data is a time series with a shifting peak. 
     694The first part of the series was fitted using the *broad_peak* model, while 
     695the rest of the data were fit using the *gaussian_peak* model. Unfortunately the 
     696time is not listed in the file but the file name contains the information. As 
     697described in :ref:`Grid_Window`, a column can be added manually, in this case 
     698called time, and the peak position plotted against time.  
    685699 
    686700.. image:: combine_batch_plot.png 
    687701 
    688 Note the discontinuity in the peak position.  This 
    689 is due to the fact that the Guassian fit is actually pretty bad and is not 
    690 actually finding the peak. 
    691  
    692 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    693  
    694 .. note::  This help document was last changed by Paul Butler, 06April2017 
     702Note the discontinuity in the peak position.  This is due to the fact that the 
     703Guassian fit is in fact a pretty bad model of the data and is not actually 
     704finding the peak. 
     705 
     706.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     707 
     708.. note::  This help document was last changed by Paul Butler, 10 September 
     709   2017 
Note: See TracChangeset for help on using the changeset viewer.