Changeset b3199ac3 in sasview for fittingview/src/sans/perspectives


Ignore:
Timestamp:
Oct 17, 2011 5:14:51 PM (13 years ago)
Author:
Jae Cho <jhjcho@…>
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.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
40c84e4
Parents:
46cec6c
Message:

some changes in help doc

Location:
fittingview/src/sans/perspectives/fitting/media
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • fittingview/src/sans/perspectives/fitting/media/batch_help.html

    rec538c7 rb3199ac3  
    88 
    99<ul> 
    10 <li><a href="#fitpage">Single Fit</a></li> 
     10<li><a href="#fitpage">Batch Fit</a></li> 
    1111<li><a href="#batchwindow">Batch Window</a></li> 
    1212</ul> 
    1313 
    14 <h5><font color="blue"><a name="fitpage">Single Fit</a></font></h5> 
     14<h5><font color="blue"><a name="fitpage">Batch Fit</a></font></h5> 
    1515<p> 
    1616Create <b>Batch Page </b> by selecting <b>Batch </b> radio button on  
    17 Data Explorer<font color="blue"><a href="#batch_button">(see figure below)</a></font>.<br /> 
    18  
     17Data Explorer<font color="blue"><a href="#batch_button">(see figure below)</a></font> 
     18and for a new control page select 'New FitPage' in the 'Fitting' menubar.<br /> 
     19</p> 
    1920<br /><img src="batch_button_area.bmp" /><br /><br /> 
    2021<a name="figure1"><u>Figure 1: MenuBar</u></a><br /> 
    21  
    22 Load Data to Data Explorer.Activate the <b>Fitting application</b> 
    23 either by selecting "Fitting" from combo box of the Data Explorer window or the menubar item  "Applications". 
    24 Send selected data to fit <font color="blue"><a href="load_data_help.html">(see Load Data help)</a></font>. 
    25 Modify the model parameters as need <font color="blue"><a href="single_fit_help.html">(see single fit help)</a></font>.  
    26 Select a new data from the Data combo box to see analyse 
    27 theory plot. Then click on fit button. 
     22<br /> 
     23Load Data to Data Explorer if not loaded. <br/> 
     24Select one or more data sets by checking the check boxes, and then make sure  
     25that "Fitting" is selected in the dropdown menu next to the "Send To" button. 
     26Once ready, click the 'Send To' button to set data to a BatchPage. If already an empty batch page exists, it will be set there. 
     27Otherwise it will create a new Batch Page. 
     28Set up the model and the parameter values as same as a single fitting <font color="blue"><a href="single_fit_help.html">(see single fit help)</a></font>. 
     29The use 'Fit' button to perform the fitting. 
     30<br />Unlike a single fit, the results of the fittings will not return to the BatchPage'. Instead, a Grid window will be provided once the fitting is completed.  
     31The Grid window is also accessible from the 'View' menu <font color="blue"><a href="#figure2">(see Figure 2)</a></font>.  
     32<br /> Note that only one model is used for all the data.  
     33The initial parameter values given in the control page will be used all the data fittings. If one wants the FitEngine to use the initial values  
     34from the results of the previous data fitting (if any), choose the 'Chain Fitting' in the Fitting menubar, which will speed up the fitting  
     35especially when you have lots of, and similar, data sets. 
    2836</p> 
    2937 
    3038<h5><font color="blue"><a name="batchwindow">Batch Window</a></font></h5> 
    3139<p> 
    32 Batch Window provides an easy way to view fit results, plot data, theory, and residuals after a batch fit is completed. 
     40Batch Window provides an easy way to view the fit results, i.e., plot data, fits, and residuals. 
    3341Batch window will be automatically shown after a batch fit is finished. <br /> 
    3442Once closed,  
    3543it can be opened anytime from the "View" menubar item <font color="blue"><a href="#figure2">(see Figure 2)</a></font>.<br /> 
    36  
     44</p> 
    3745<br /><br /><img src="restore_batch_window.bmp" /><br /><br /> 
    3846<a name="#figure2"><u>Figure 2: Edit Menu</u></a><br /> 
     47<br /> 
    3948  <ul> 
    4049        <li> <a href="#edit_grid"> Edit Grid </a></li> 
    … …  
    4453        <li><a href="#view"> View Column/Cell(s) </a></li> 
    4554   </ul> 
    46 </p> 
     55 
    4756 
    4857 
    4958<h5><font color="blue"><a name="edit_grid"> Edit Grid </a></font></h5> 
    5059<p> 
    51 Once a batch fit is completed all fitted and fixed model parameters are displayed to the current sheet of 
    52 the batch window, except errors on parameters. To view errors on fitted parameters or data parameters,  
    53 click on a given column then under <b> Edit </b> menubar item and insert the desired parameter by selected 
     60Once a batch fit is completed, all fitted and fixed model parameters are displayed to the current sheet of 
     61the batch window except the errors of the parameters. To view the errors,  
     62click on a given column then under <b> Edit </b> menubar item, and insert the desired parameter by selecting  
    5463a menu item with the appropriated label. Empty column can be inserted in the same way. 
    55 Column value can be customized by editing an existing empty column.<br /> 
    56 To Remove column from the grid, selected it, click on edit menu, and click on <b> remove </b>  menu item. 
    57 Any removed column should reinserted when needed.<br /> 
     64A column value can be customized by editing an existing empty column.<br /> 
     65To Remove column from the grid, select it, choose edit menu, and click the <b> 'remove' </b>  menu item. 
     66Any removed column should reinserted whenever needed.<br /> 
    5867All above options are also available when right clicking on a given column label  
    5968<font color="blue"><a href="#figure3">(see Figure 3)</a></font>. 
    60 <b>Note:</b> A column always need to be selected in order to remove or insert a column in the grid.<br /><br /> 
     69<b>Note:</b> A column always needs to be selected in order to remove or insert a column in the grid.<br /><br /> 
    6170 
    6271<img src="edit_menu.bmp" /><br /><br /> 
    … …  
    6776<h5><font color="blue"><a name="save_grid"> Save Grid </a></font></h5> 
    6877<p> 
    69 To save the current page on the batch window, select <b> File </b> menubar item  
    70 <font color="blue"><a href="#figure4">(see Figure 4)</a></font>, then select <b> Save as </b> 
     78To save the current page on the batch window, select the <b> 'File' </b> menubar item  
     79<font color="blue"><a href="#figure4">(see Figure 4)</a></font>, then choose the <b> 'Save as' </b> 
    7180menu item to save it as a .csv file. <br /> 
    72 <b>Note: </b> The grid doesn't save data, theory, and residuals plots. As a result, the view functionality  
     81<b>Note: </b> The grid doesn't save the data array, fits, and the array residuals. As a result, the 'View (fit) Results' functionality  
    7382will be lost  when reloading the saved file.<br /> 
    7483 
    … …  
    8089<h5><font color="blue"><a name="load_batch"> Open Batch Results </a></font></h5> 
    8190<p> 
    82 Any <b> csv </b> file can be opened in the grid by selecting <b> Open </b>  
    83 under <b> File</b> menu <font color="blue"><a href="#figure4">(see Figure 4)</a></font>.  
     91Any <b> csv </b> file can be opened in the grid by selecting the <b> 'Open' </b>  
     92under the <b> 'File' </b> menu in the Grid Window <font color="blue"><a href="#figure4">(see Figure 4)</a></font>.  
    8493All columns in the file will be displayed but insertion will not available.  
    8594Insertion will be available only when at least one column will be 
    … …  
    94103<p> 
    95104To <b> plot </b> a column versus another, 
    96 select one column at the time, click on <b> Add </b> button next to text control 
     105select one column at the time, click the <b> 'Add' </b> button next to the text control 
    97106 of X/Y -axis <b> Selection Range </b> 
    98 to plot the value of this column on the X/Y axis. 
    99 Repeat the same procedure the next axis.Finally , click on <b> Plot </b> button.  
     107to plot the value of this column on the X/Y axis. Alternatively, all available range can be selected by clicking the column letter (eg. B). 
     108Repeat the same procedure the next axis. Finally, click the <b> 'Plot' </b> button.  
    100109When clicking on <b> Add </b> button, the grid 
    101110will automatically fill the axis label, but  different labels and units can be  
    … …  
    120129 <font color="#CC9933">scale</font>[2 : 5] <br /><br /> 
    121130 
    122 2) if only some value of a given column are need but the range between  
    123 the first row and last row used is not continuous,<br />write 
     1312) if only some values of a given column are need but the range between  
     132the first row and the last row used is not continuous,<br />write 
    124133the following expression in the text control: <br /> 
    125134<font color="#CC9933">column_name1</font> 
    … …  
    144153<h5><font color="blue"><a name="view"> View Column/Cell(s) </a></font></h5> 
    145154<p> 
    146 Select 1 or more cell from the same column, click <b>View Results</b> 
    147 button  to display available curves. 
    148 For example selecting cells of <b> Chi2 </b> column, then click on <b> view </b>  
    149 button. The plots generates will represent <b>residuals </b> plots. <br /> 
     155Select 1 or more cells from the same column, click the <b> 'View Results' </b> 
     156button  to display available curves. <br /> 
    150157 
    151 If you select any cells of <b> Data </b> column, then click on  
    152 <b> view </b> button. The plots generates will represent  
    153 <b>data and theory model</b> plots <font color="blue"><a href="#figure6">(see Figure 6)</a></font>. <br /> 
     158For example, select the cells of the <b> 'Chi2' </b> column, then click the <b> 'View Results' </b>  
     159button. The plots generates will represent the <b>residuals </b> plots. <br /> 
     160  
    154161 
     162If you select any cells of the <b> 'Data' </b> column and click the 
     163<b> 'View Results' </b> button. It generates both 
     164<b> data and fits</b> in the graph <font color="blue"><a href="#figure6">(see Figure 6)</a></font>. <br /> 
     165 
     166<b>Alternatively, just click the column letter (eg. B)  
     167to choose all the available Data sets, then simply click the 'View Results' button to plot the data and fits.  
     168</b> 
     169<br /> 
    155170<br /><br /><img src="view_button.bmp" /><br /><br /> 
    156171<a name="figure6"><u>Figure 6: View Results</u></a><br /><br /> 

  • fittingview/src/sans/perspectives/fitting/media/simultaneous_fit_help.html

    r2c90c74 rb3199ac3  
    44<h4>Simultaneous Fit</h4> 
    55<p> 
    6         Can only happen with more than 2 data select with their associated model. 
    7         Can only operate with the park engine selected <b>Fitting</b> on the menu. 
    8         check <b> park</b>. 
     6        This fitting option enables to set a number of the constraints between the parameters of fitting(s). 
     7        It requires one or more FitPages with a data and a model set for the fitting,  
     8        and performs multiple fittings given by the FitPage(s). 
     9        The Complex (ParkMC) FitEngine will be used automatically. 
    910</p> 
    1011<ul> 
    … …  
    1516<h5><a name="noconstraint">Simultaneous Fit without constraint</a></h5> 
    1617<p>  
    17         Highlight the data to fit. Select from the context menu <b>Select Data for fitting</b>. 
    18         A new tab with the name of the data selected will appears. Select a model used for the fit 
    19         from the combo box. Model's parameters will be display.Set initial parameters if need. 
    20         Check at least one parameter to fit.Go to <b>Simultaneous Fit</b> and check at least 2 
    21         models name to fit.Click on <b> constraint fit </b> button. results will be displayed on  
    22         tabs corresponding to each model select. 
     18        Assuming some FitPage are already set up, check the checkboxes of the model_data rows to fit. 
     19        And click the 'Fit' button.  
     20        The results will return to each FitPages.  
     21        <br/>Note that the chi2/Npts returned is the sum of the chi2/Npts of each fits.  
     22        If one needs the chi2 value only for a page, click the 'Compute' button in the FitPage to recalculate. 
    2323         
    2424</p> 
    … …  
    2626<h5><a name="constraint">Simultaneous Fit with constraint</a></h5> 
    2727<p> 
    28         Perform <a href="#noconstraint">Simultaneous Fit without constraint</a> step. 
    2928        Enter constraint in the text control next to  <b>constraint fit</b> button. 
    3029        Constraint should be of type model1 parameter name = f(model2 parameter name)for example, M0.radius=2*M1.radius. 
    3130        Many constraints can be entered for a single fit.Each of them should be separated  
    3231        by a newline charater or ";" 
     32        The easy setup can generate many constraint inputs easily when the selected two models are the same type. 
     33        <br/>Note that the chi2/Npts returned is the sum of the chi2/Npts of each fits.  
     34        If one needs the chi2 value only for one fit, click the 'Compute' button in the FitPage to recalculate. 
    3335</p> 
    3436 

  • fittingview/src/sans/perspectives/fitting/media/single_fit_help.html

    r2c90c74 rb3199ac3  
    1010<h5><a name="fitpage">Single Fit</a></h5> 
    1111<p>  
    12         Move the mouse pointer to the data plot to highlight (yellow).  When right clicking and holding, a pop-up (context) menu will appear.  
    13         Select from the context menu <b>Select Data for fitting</b>. 
    14         A new tab with the name of the data selected will appears. Select a model used for the fit 
    15         from the combo box. Model's parameters will be display.Set initial parameters if need. 
    16         Check at least one parameter to fit.Click on <b> Fit</b> button. 
    17         New parameters values will be displayed as well as error and new chi square associated 
    18         with the fit operation. 
    19         The model will be replotted with its new values. 
    20         Errors will be display on the statusbar. 
    21         Single fit can also be perform on the "<b>simultaneous fit </b>" tab is parameters are previously  
    22         selected on the page corresponding to a model name check. if one model is check, click  
    23         on <b> constraint fit </b> button to perform a single fit. results will be displayed on  
    24         the appropriate tab. 
     12        One of two fit-engines can be chosen from the Fitting menu bar. The Simple Fit-engine uses Scipy's leasqr  
     13        and the Complex Fit-Engine is a custom optimizer that provides a better chance  
     14        to find the global minimum of the chi2 but that requires longer computation time. 
     15        In order to set a data to a control panel (FitPage), see the "DataLoader Help". 
     16        Once a data set to the FiPage, select a model from the combo box.  
     17        The default parameters of the model will be display. Set initial parameters if need. 
     18        Check and uncheck parameters to fit/fix. Click the <b> 'Fit'</b> button. 
     19        When the fitting is finished, the resultant parameter values will be displayed with the errors. If a error is missing, it generally means  
     20        that the corresponding parameter is not very depending on the model. The chisq/Npt_fit and the plot associated 
     21        with the fit operation will be also updated. 
    2522         
    2623</p> 
Note: See TracChangeset for help on using the changeset viewer.