Changeset b3199ac3 in sasview for fittingview/src/sans/perspectives/fitting/media/batch_help.html

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

File:

• fittingview/src/sans/perspectives/fitting/media/batch_help.html (modified) (7 diffs)

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

@@ -8 +8 @@
 
 <ul>
-<li><a href="#fitpage">Single Fit</a></li>
+<li><a href="#fitpage">Batch Fit</a></li>
 <li><a href="#batchwindow">Batch Window</a></li>
 </ul>
 
-<h5><font color="blue"><a name="fitpage">Single Fit</a></font></h5>
+<h5><font color="blue"><a name="fitpage">Batch Fit</a></font></h5>
 <p>
 Create <b>Batch Page </b> by selecting <b>Batch </b> radio button on 
-Data Explorer<font color="blue"><a href="#batch_button">(see figure below)</a></font>.<br />
-
+Data Explorer<font color="blue"><a href="#batch_button">(see figure below)</a></font>
+and for a new control page select 'New FitPage' in the 'Fitting' menubar.<br />
+</p>
 <br /><img src="batch_button_area.bmp" /><br /><br />
 <a name="figure1"><u>Figure 1: MenuBar</u></a><br />
-
-Load Data to Data Explorer.Activate the <b>Fitting application</b>
-either by selecting "Fitting" from combo box of the Data Explorer window or the menubar item  "Applications".
-Send selected data to fit <font color="blue"><a href="load_data_help.html">(see Load Data help)</a></font>.
-Modify the model parameters as need <font color="blue"><a href="single_fit_help.html">(see single fit help)</a></font>. 
-Select a new data from the Data combo box to see analyse
-theory plot. Then click on fit button.
+<br />
+Load Data to Data Explorer if not loaded. <br/>
+Select one or more data sets by checking the check boxes, and then make sure 
+that "Fitting" is selected in the dropdown menu next to the "Send To" button.
+Once ready, click the 'Send To' button to set data to a BatchPage. If already an empty batch page exists, it will be set there.
+Otherwise it will create a new Batch Page.
+Set 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>.
+The use 'Fit' button to perform the fitting.
+<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. 
+The Grid window is also accessible from the 'View' menu <font color="blue"><a href="#figure2">(see Figure 2)</a></font>. 
+<br /> Note that only one model is used for all the data. 
+The 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 
+from the results of the previous data fitting (if any), choose the 'Chain Fitting' in the Fitting menubar, which will speed up the fitting 
+especially when you have lots of, and similar, data sets.
 </p>
 
 <h5><font color="blue"><a name="batchwindow">Batch Window</a></font></h5>
 <p>
-Batch Window provides an easy way to view fit results, plot data, theory, and residuals after a batch fit is completed.
+Batch Window provides an easy way to view the fit results, i.e., plot data, fits, and residuals.
 Batch window will be automatically shown after a batch fit is finished. <br />
 Once closed, 
 it can be opened anytime from the "View" menubar item <font color="blue"><a href="#figure2">(see Figure 2)</a></font>.<br />
-
+</p>
 <br /><br /><img src="restore_batch_window.bmp" /><br /><br />
 <a name="#figure2"><u>Figure 2: Edit Menu</u></a><br />
+<br />
   <ul>
         <li> <a href="#edit_grid"> Edit Grid </a></li>
@@ -44 +53 @@
         <li><a href="#view"> View Column/Cell(s) </a></li>
    </ul>
-</p>
+
 
 
 <h5><font color="blue"><a name="edit_grid"> Edit Grid </a></font></h5>
 <p>
-Once a batch fit is completed all fitted and fixed model parameters are displayed to the current sheet of
-the batch window, except errors on parameters. To view errors on fitted parameters or data parameters, 
-click on a given column then under <b> Edit </b> menubar item and insert the desired parameter by selected
+Once a batch fit is completed, all fitted and fixed model parameters are displayed to the current sheet of
+the batch window except the errors of the parameters. To view the errors, 
+click on a given column then under <b> Edit </b> menubar item, and insert the desired parameter by selecting 
 a menu item with the appropriated label. Empty column can be inserted in the same way.
-Column value can be customized by editing an existing empty column.<br />
-To Remove column from the grid, selected it, click on edit menu, and click on <b> remove </b>  menu item.
-Any removed column should reinserted when needed.<br />
+A column value can be customized by editing an existing empty column.<br />
+To Remove column from the grid, select it, choose edit menu, and click the <b> 'remove' </b>  menu item.
+Any removed column should reinserted whenever needed.<br />
 All above options are also available when right clicking on a given column label 
 <font color="blue"><a href="#figure3">(see Figure 3)</a></font>.
-<b>Note:</b> A column always need to be selected in order to remove or insert a column in the grid.<br /><br />
+<b>Note:</b> A column always needs to be selected in order to remove or insert a column in the grid.<br /><br />
 
 <img src="edit_menu.bmp" /><br /><br />
@@ -67 +76 @@
 <h5><font color="blue"><a name="save_grid"> Save Grid </a></font></h5>
 <p>
-To save the current page on the batch window, select <b> File </b> menubar item 
-<font color="blue"><a href="#figure4">(see Figure 4)</a></font>, then select <b> Save as </b>
+To save the current page on the batch window, select the <b> 'File' </b> menubar item 
+<font color="blue"><a href="#figure4">(see Figure 4)</a></font>, then choose the <b> 'Save as' </b>
 menu item to save it as a .csv file. <br />
-<b>Note: </b> The grid doesn't save data, theory, and residuals plots. As a result, the view functionality 
+<b>Note: </b> The grid doesn't save the data array, fits, and the array residuals. As a result, the 'View (fit) Results' functionality 
 will be lost  when reloading the saved file.<br />
 
@@ -80 +89 @@
 <h5><font color="blue"><a name="load_batch"> Open Batch Results </a></font></h5>
 <p>
-Any <b> csv </b> file can be opened in the grid by selecting <b> Open </b> 
-under <b> File</b> menu <font color="blue"><a href="#figure4">(see Figure 4)</a></font>. 
+Any <b> csv </b> file can be opened in the grid by selecting the <b> 'Open' </b> 
+under the <b> 'File' </b> menu in the Grid Window <font color="blue"><a href="#figure4">(see Figure 4)</a></font>. 
 All columns in the file will be displayed but insertion will not available. 
 Insertion will be available only when at least one column will be
@@ -94 +103 @@
 <p>
 To <b> plot </b> a column versus another,
-select one column at the time, click on <b> Add </b> button next to text control
+select one column at the time, click the <b> 'Add' </b> button next to the text control
  of X/Y -axis <b> Selection Range </b>
-to plot the value of this column on the X/Y axis.
-Repeat the same procedure the next axis.Finally , click on <b> Plot </b> button. 
+to 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).
+Repeat the same procedure the next axis. Finally, click the <b> 'Plot' </b> button. 
 When clicking on <b> Add </b> button, the grid
 will automatically fill the axis label, but  different labels and units can be 
@@ -120 +129 @@
  <font color="#CC9933">scale</font>[2 : 5] <br /><br />
 
-2) if only some value of a given column are need but the range between 
-the first row and last row used is not continuous,<br />write
+2) if only some values of a given column are need but the range between 
+the first row and the last row used is not continuous,<br />write
 the following expression in the text control: <br />
 <font color="#CC9933">column_name1</font>
@@ -144 +153 @@
 <h5><font color="blue"><a name="view"> View Column/Cell(s) </a></font></h5>
 <p>
-Select 1 or more cell from the same column, click <b>View Results</b>
-button  to display available curves.
-For example selecting cells of <b> Chi2 </b> column, then click on <b> view </b> 
-button. The plots generates will represent <b>residuals </b> plots. <br />
+Select 1 or more cells from the same column, click the <b> 'View Results' </b>
+button  to display available curves. <br />
 
-If you select any cells of <b> Data </b> column, then click on 
-<b> view </b> button. The plots generates will represent 
-<b>data and theory model</b> plots <font color="blue"><a href="#figure6">(see Figure 6)</a></font>. <br />
+For example, select the cells of the <b> 'Chi2' </b> column, then click the <b> 'View Results' </b> 
+button. The plots generates will represent the <b>residuals </b> plots. <br />
+ 
 
+If you select any cells of the <b> 'Data' </b> column and click the
+<b> 'View Results' </b> button. It generates both
+<b> data and fits</b> in the graph <font color="blue"><a href="#figure6">(see Figure 6)</a></font>. <br />
+
+<b>Alternatively, just click the column letter (eg. B) 
+to choose all the available Data sets, then simply click the 'View Results' button to plot the data and fits. 
+</b>
+<br />
 <br /><br /><img src="view_button.bmp" /><br /><br />
 <a name="figure6"><u>Figure 6: View Results</u></a><br /><br />