Changeset dbba134 in sasview


Ignore:
Timestamp:
May 18, 2018 6:52:33 AM (7 months ago)
Author:
Piotr Rozyczko <rozyczko@…>
Branches:
ESS_GUI, ESS_GUI_Invariant, ESS_GUI_Pr_fixes, ESS_GUI_batch_fitting, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_ordering
Children:
de1c5ed, 3b349ee
Parents:
d3ee425
Message:

More fitting help updates - SASVIEW-917

Location:
src/sas/qtgui/Perspectives/Fitting/media
Files:
4 added
3 edited

Legend:

Unmodified
Added
Removed
  • src/sas/qtgui/Perspectives/Fitting/media/fitting_help.rst

    rb31b7e2 rdbba134  
    5757The graph will update dynamically as the parameter values are changed. 
    5858 
    59 You can decide your own model categorizations using the :ref:`Category_Manager`. 
     59.. TODO: uncomment after Category_Manager done 
     60.. You can decide your own model categorizations using the :ref:`Category_Manager`. 
    6061 
    6162Once you have selected a model you can read its help documentation by right clicking 
     
    7778.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    7879 
    79 .. _Category_Manager: 
    80  
    81 Category Manager 
    82 ---------------- 
    83  
    84 To change the model categorizations, either choose *Category Manager* from the 
    85 *View* option on the menubar, or click on the *Modify* button on the *Fit Page*. 
    86  
    87 .. image:: cat_fig0.png 
    88  
    89 The categorization of all models except the user supplied Plugin Models can be 
    90 reassigned, added to, and removed using *Category Manager*. Models can also be 
    91 hidden from view in the drop-down menus. 
    92  
    93 .. image:: cat_fig1.png 
    94  
    95 Changing category 
    96 ^^^^^^^^^^^^^^^^^ 
    97  
    98 To change category, highlight a model in the list by left-clicking on its entry 
    99 and then click the *Modify* button. Use the *Change Category* panel that appears 
    100 to make the required changes. 
    101  
    102 .. image:: cat_fig2.png 
    103  
    104 To create a category for the selected model, click the *Add* button. In order 
    105 to delete a category, select the category name and click the *Remove Selected* 
    106 button. Then click *Done*. 
    107  
    108 Showing/hiding models 
    109 ^^^^^^^^^^^^^^^^^^^^^ 
    110  
    111 Use the *Enable All / Disable All* buttons and the check boxes beside each model 
    112 to select the models to show/hide. To apply the selection, click *Ok*. Otherwise 
    113 click *Cancel*. 
    114  
    115 *NB: It may be necessary to change to a different category and then back again* 
    116 *before any changes take effect.* 
    117  
     80.. TODO: uncomment after Category_Manager done 
     81.. 
     82  .. _Category_Manager: 
     83 
     84  Category Manager 
     85  ---------------- 
     86 
     87  To change the model categorizations, either choose *Category Manager* from the 
     88  *View* option on the menubar, or click on the *Modify* button on the *Fit Page*. 
     89 
     90  .. image:: cat_fig0.png 
     91 
     92  The categorization of all models except the user supplied Plugin Models can be 
     93  reassigned, added to, and removed using *Category Manager*. Models can also be 
     94  hidden from view in the drop-down menus. 
     95 
     96  .. image:: cat_fig1.png 
     97 
     98  Changing category 
     99  ^^^^^^^^^^^^^^^^^ 
     100 
     101  To change category, highlight a model in the list by left-clicking on its entry 
     102  and then click the *Modify* button. Use the *Change Category* panel that appears 
     103  to make the required changes. 
     104 
     105  .. image:: cat_fig2.png 
     106 
     107  To create a category for the selected model, click the *Add* button. In order 
     108  to delete a category, select the category name and click the *Remove Selected* 
     109  button. Then click *Done*. 
     110 
     111  Showing/hiding models 
     112  ^^^^^^^^^^^^^^^^^^^^^ 
     113 
     114  Use the *Enable All / Disable All* buttons and the check boxes beside each model 
     115  to select the models to show/hide. To apply the selection, click *Ok*. Otherwise 
     116  click *Cancel*. 
     117 
     118  *NB: It may be necessary to change to a different category and then back again* 
     119  *before any changes take effect.* 
     120.. 
    118121.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    119122 
     
    535538them in the first place!). 
    536539 
    537 To tie parameters between the data sets with constraints, check the 'yes' radio button 
    538 next to *Add Constraint?* in the *Fit Constraints* box. 
    539  
    540 *NB: You can only constrain parameters that are set to refine.* 
     540.. image:: constraint_1.png 
     541 
     542To tie parameters between the data sets with constraints, select the data sets and right click. 
     543From the menu choose *Mutual constraint of parameters in selected models* 
     544 
     545.. image:: constraint_2.png 
    541546 
    542547When ready, click the *Fit* button on the *Const & Simul Fit* page, NOT the *Fit* 
     
    556561^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
    557562 
    558 Use the *Easy Setup* drop-down buttons in the *Const & Simul Fit* page to set 
    559 up constraints between *FitPage*'s. 
     563In the *Const. & Simul. Fit* page select two data sets which are to be constrained. 
     564Right clicking in the *Source choice for simultaneous fitting* area will bring up 
     565the context menu: 
     566 
     567.. image:: constraint_2.png 
     568 
     569Here you can choose datasets for fitting and define constraints between parameters in 
     570both datasets. 
     571 
     572Selecting this option will bring up the *Complex Constraint* dialog. 
     573 
     574.. image:: complex_constraint.png 
    560575 
    561576Constraints will generally be of the form 
     
    668683.. image:: restore_batch_window.png 
    669684 
    670 Once a batch fit is completed, all model parameters are displayed but *not* 
    671 their uncertainties. To view the uncertainties, click on a given column then 
    672 go to *Edit* in the menu bar, select *Insert Column Before* and choose the 
    673 required data from the list. An empty column can be inserted in the same way. 
    674  
    675 To remove a column from the grid, click on the column header and choose 
    676 *Remove Column* under *Edit* in the menu bar. The same functionality also 
    677 allows you to re-order columns. 
    678  
    679 *NB: You cannot insert/remove/re-order the rows in the Grid Window.* 
    680  
    681 All of the above functions are also available by right-clicking on a column 
    682 label. 
    683  
    684 .. image:: edit_menu.png 
    685  
    686 *NB: If there is an existing Grid Window and another batch fit is performed,* 
     685.. 
     686  Once a batch fit is completed, all model parameters are displayed but *not* 
     687  their uncertainties. To view the uncertainties, click on a given column then 
     688  go to *Edit* in the menu bar, select *Insert Column Before* and choose the 
     689  required data from the list. An empty column can be inserted in the same way. 
     690 
     691 
     692  To remove a column from the grid, click on the column header and choose 
     693  *Remove Column* under *Edit* in the menu bar. The same functionality also 
     694  allows you to re-order columns. 
     695 
     696  *NB: You cannot insert/remove/re-order the rows in the Grid Window.* 
     697 
     698  All of the above functions are also available by right-clicking on a column 
     699  label. 
     700 
     701  .. image:: edit_menu.png 
     702.. 
     703 
     704If there is an existing Grid Window and another batch fit is performed,* 
    687705*an additional 'Table' tab will be added to the Grid Window.* 
    688706 
     
    704722^^^^^^^^^^^^^^^ 
    705723 
    706 Any column of *numeric* parameter values can be plotted against another using 
    707 the *Grid Window*. Simply select one column at the time and click the *Add* 
    708 button next to the required *X/Y-axis Selection Range* text box. When both 
    709 the X and Y axis boxes have been completed, click the *Plot* button. 
    710  
    711 When the *Add* button is clicked, *SasView* also automatically completes the 
    712 *X/Y-axis Label* text box with the heading from Row 1 of the selected table, 
    713 but different labels and units can be entered manually. 
    714  
    715 .. image:: plot_button.png 
    716  
    717 The *X/Y-axis Selection Range* can be edited manually. The text control box 
    718 recognises the operators +, -, \*, /, or 'pow', and allows the following 
    719 types of expression : 
    720  
    721   1) if an axis label range is a function of 1 or more *columns*, write 
    722      this type of expression 
    723  
    724      constant1 * column_name1 [minimum row index :  maximum  row index] 
    725      operator constant2 * column_name2 [minimum row index :  maximum  row index] 
    726  
    727      Example: radius [2 : 5] -3 * scale [2 : 5] 
    728  
    729   2) if only some *values* of a given column are needed but the range between 
    730      the first row and the last row used is not continuous, write this type of 
    731      expression 
    732  
    733      column_name1 [minimum row index1 :  maximum  row index1] , column_name1 
    734      [minimum row index2 :  maximum  row index2] 
    735  
    736      Example: radius [2 : 5] , radius [10 : 25] 
     724.. 
     725  Any column of *numeric* parameter values can be plotted against another using 
     726  the *Grid Window*. Simply select one column at the time and click the *Add* 
     727  button next to the required *X/Y-axis Selection Range* text box. When both 
     728  the X and Y axis boxes have been completed, click the *Plot* button. 
     729 
     730  When the *Add* button is clicked, *SasView* also automatically completes the 
     731  *X/Y-axis Label* text box with the heading from Row 1 of the selected table, 
     732  but different labels and units can be entered manually. 
     733 
     734  .. image:: plot_button.png 
     735 
     736  The *X/Y-axis Selection Range* can be edited manually. The text control box 
     737  recognises the operators +, -, \*, /, or 'pow', and allows the following 
     738  types of expression : 
     739 
     740    1) if an axis label range is a function of 1 or more *columns*, write 
     741      this type of expression 
     742 
     743      constant1 * column_name1 [minimum row index :  maximum  row index] 
     744      operator constant2 * column_name2 [minimum row index :  maximum  row index] 
     745 
     746      Example: radius [2 : 5] -3 * scale [2 : 5] 
     747 
     748    2) if only some *values* of a given column are needed but the range between 
     749      the first row and the last row used is not continuous, write this type of 
     750      expression 
     751 
     752      column_name1 [minimum row index1 :  maximum  row index1] , column_name1 
     753      [minimum row index2 :  maximum  row index2] 
     754 
     755      Example: radius [2 : 5] , radius [10 : 25] 
     756.. 
     757 
     758Any row (dataset) can be plotted by selecting it and either right-clicking and choosing 
     759*Plot selected fits* menu item or by clicking on the *Plot* button. 
    737760 
    738761.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     
    761784described in :ref:`Loading_data`. Next start up two or more *BatchPage* fits 
    762785following the instructions in :ref:`Batch_Fit_Mode` but **DO NOT PRESS FIT**. 
    763 At this point the *Combine Batch Fit* menu item under the *Fitting menu* should 
    764 be active (if there is one or no *BatchPage* the menu item will be greyed out 
    765 and inactive).  Clicking on *Combine Batch Fit* will bring up a new panel, 
    766 similar to the *Const & Simult Fit* panel. In this case there will be a 
    767 checkbox for each *BatchPage* instead of each *FitPage* that should be included 
    768 in the fit.  Once all are selected, click the Fit button on 
    769 the *BatchPage* to run each batch fit in *sequence* 
    770  
    771 .. image:: combine_batch_page.png 
     786 
     787When done, select *Constrained or Simultaneous Fit* under *Fitting* in the menu bar. 
     788 
     789In the *Const & Simul Fit* page that appears, choose *Batch fits* radio button and 
     790select which data sets are to be  fitted. 
     791 
     792.. image:: simult_batch.png 
     793 
     794Once all are selected, click the Fit button on 
     795the *Const. Simult. Fitting* to run each batch fit in *sequence* 
     796 
    772797 
    773798The batch table will then pop up at the end as for the case of the simple Batch 
     
    786811   recognized as the same parameter. 
    787812 
    788 .. image:: combine_batch_grid.png 
    789  
    790 In the example shown above the data is a time series with a shifting peak. 
    791 The first part of the series was fitted using the *broad_peak* model, while 
    792 the rest of the data were fit using the *gaussian_peak* model. Unfortunately the 
    793 time is not listed in the file but the file name contains the information. As 
    794 described in :ref:`Grid_Window`, a column can be added manually, in this case 
    795 called time, and the peak position plotted against time. 
    796  
    797 .. image:: combine_batch_plot.png 
    798  
    799 Note the discontinuity in the peak position.  This reflects the fact that the 
    800 Gaussian fit is a rather poor model for the data and is not actually 
    801 finding the peak. 
    802  
    803 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    804  
    805 .. note::  This help document was last changed by Paul Butler, 10 September 
    806    2017 
     813 
     814.. 
     815  .. image:: combine_batch_grid.png 
     816 
     817  In the example shown above the data is a time series with a shifting peak. 
     818  The first part of the series was fitted using the *broad_peak* model, while 
     819  the rest of the data were fit using the *gaussian_peak* model. Unfortunately the 
     820  time is not listed in the file but the file name contains the information. As 
     821  described in :ref:`Grid_Window`, a column can be added manually, in this case 
     822  called time, and the peak position plotted against time. 
     823 
     824  .. image:: combine_batch_plot.png 
     825 
     826  Note the discontinuity in the peak position.  This reflects the fact that the 
     827  Gaussian fit is a rather poor model for the data and is not actually 
     828  finding the peak. 
     829.. 
     830.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     831 
     832.. note::  This help document was last changed by Piotr Rozyczko, 18 May 2018 
Note: See TracChangeset for help on using the changeset viewer.