source: sasview/fittingview/src/sans/perspectives/fitting/media/batch_help.html @ 96814e1

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 96814e1 was b3199ac3, checked in by Jae Cho <jhjcho@…>, 13 years ago

some changes in help doc
  • Property mode set to 100644
File size: 8.5 KB
RevLine 
[ec538c7]1<html>
2<head>
3</head>
4
5
6<body>
7<h4> Batch Fit </h4>
8
9<ul>
[b3199ac3]10<li><a href="#fitpage">Batch Fit</a></li>
[ec538c7]11<li><a href="#batchwindow">Batch Window</a></li>
12</ul>
13
[b3199ac3]14<h5><font color="blue"><a name="fitpage">Batch Fit</a></font></h5>
[ec538c7]15<p>
16Create <b>Batch Page </b> by selecting <b>Batch </b> radio button on
[b3199ac3]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>
[ec538c7]20<br /><img src="batch_button_area.bmp" /><br /><br />
21<a name="figure1"><u>Figure 1: MenuBar</u></a><br />
[b3199ac3]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.
[ec538c7]36</p>
37
38<h5><font color="blue"><a name="batchwindow">Batch Window</a></font></h5>
39<p>
[b3199ac3]40Batch Window provides an easy way to view the fit results, i.e., plot data, fits, and residuals.
[ec538c7]41Batch window will be automatically shown after a batch fit is finished. <br />
42Once closed,
43it can be opened anytime from the "View" menubar item <font color="blue"><a href="#figure2">(see Figure 2)</a></font>.<br />
[b3199ac3]44</p>
[ec538c7]45<br /><br /><img src="restore_batch_window.bmp" /><br /><br />
46<a name="#figure2"><u>Figure 2: Edit Menu</u></a><br />
[b3199ac3]47<br />
[ec538c7]48  <ul>
49        <li> <a href="#edit_grid"> Edit Grid </a></li>
50        <li><a href="#save_grid"> Save Grid </a></li>
51        <li><a href="#load_batch"> Open Batch Results </a></li>
52        <li><a href="#plot"> Plot </a></li>
53        <li><a href="#view"> View Column/Cell(s) </a></li>
54   </ul>
[b3199ac3]55
[ec538c7]56
57
58<h5><font color="blue"><a name="edit_grid"> Edit Grid </a></font></h5>
59<p>
[b3199ac3]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
[ec538c7]63a menu item with the appropriated label. Empty column can be inserted in the same way.
[b3199ac3]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 />
[ec538c7]67All above options are also available when right clicking on a given column label
68<font color="blue"><a href="#figure3">(see Figure 3)</a></font>.
[b3199ac3]69<b>Note:</b> A column always needs to be selected in order to remove or insert a column in the grid.<br /><br />
[ec538c7]70
71<img src="edit_menu.bmp" /><br /><br />
72<a name="figure3"><u>Figure 3: Edit Menu</u></a><br />
73</p>
74
75
76<h5><font color="blue"><a name="save_grid"> Save Grid </a></font></h5>
77<p>
[b3199ac3]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>
[ec538c7]80menu item to save it as a .csv file. <br />
[b3199ac3]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
[ec538c7]82will be lost  when reloading the saved file.<br />
83
84<font color="red">Warning! To ensure accuracy of saved fit results, It is recommended to save the current grid
85before modifying it . </font>
86</p>
87
88
89<h5><font color="blue"><a name="load_batch"> Open Batch Results </a></font></h5>
90<p>
[b3199ac3]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>.
[ec538c7]93All columns in the file will be displayed but insertion will not available.
94Insertion will be available only when at least one column will be
95removed from the grid.
96
97<br /><img src="file_menu.bmp" /><br /><br />
98<a name="figure4"><u>Figure 4: MenuBar</u></a><br />
99</p>
100
101
102<h5><font color="blue"><a name="plot"> Plot </a></font></h5>
103<p>
104To <b> plot </b> a column versus another,
[b3199ac3]105select one column at the time, click the <b> 'Add' </b> button next to the text control
[ec538c7]106 of X/Y -axis <b> Selection Range </b>
[b3199ac3]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.
[ec538c7]109When clicking on <b> Add </b> button, the grid
110will automatically fill the axis label, but  different labels and units can be
111entered  in the correct controls before clicking
112on the plot button.<br />
113<b>X/Y -Axis Selection Range </b> can be edited manually. These text controls
114allows the following types of expression:<br />
115
116operation can be <font color="#00CC33"><b>+</b></font>,<font color="#00CC33">
117<b> -</b></font>, <font color="#00CC33"><b>*</b></font>,
118<font color="#00CC33"><b>/</b></font>, or <font color="#00CC33">pow</font>.<br /> <br />
119
1201) if the current axis label range is a function of 1 or more columns,
121 write this type of expression: <br />
122constant1  * <font color="#CC9933">column_name1</font>
123<font color="blue">[minimum row index :  maximum  row index]</font> 
124<font color="#00CC33">operator</font>  constant2 <font color="#00CC33">
125<b>*</b></font> <font color="#CC9933">column_name2</font>
126<font color="blue">[minimum row index :  maximum  row index]</font> <br />
127Example : <font color="#CC9933">radius</font>[2 : 5]<font color="#00CC33"><big><
128b> -</b></big></font> 3 <font color="#00CC33"><b>*</b></font>
129 <font color="#CC9933">scale</font>[2 : 5] <br /><br />
130
[b3199ac3]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
[ec538c7]133the following expression in the text control: <br />
134<font color="#CC9933">column_name1</font>
135<font color="blue">[minimum row index1 :  maximum  row index1]</font>
136<font color="#00CC33"><big><b> , </b></big></font> 
137<font color="#CC9933">column_name1</font>
138<font color="blue">[minimum row index2 :  maximum  row index2]</font> <br />
139Example : <font color="#CC9933">radius </font><font color="blue"> [2 : 5] </font>
140<font color="#00CC33"><big><b> , </b></big></font><font color="#CC9933">radius </font>
141 <font color="blue">[10 : 25] </font><br /><br />
142
143
144<b>Note: </b>Both text controls ( X and Y -axis Selection Range) need to be filled
145with valid entries for plotting to work <font color="blue"><a href="#figure5">(see Figure 5)</a></font>.
146
147<br /><br /><img src="plot_button.bmp" /><br /><br />
148<a name="figure5"><u>Figure 5: Plotting</u></a><br />
149
150</p>
151
152
153<h5><font color="blue"><a name="view"> View Column/Cell(s) </a></font></h5>
154<p>
[b3199ac3]155Select 1 or more cells from the same column, click the <b> 'View Results' </b>
156button  to display available curves. <br />
157
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 
[ec538c7]161
[b3199ac3]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 />
[ec538c7]165
[b3199ac3]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 />
[ec538c7]170<br /><br /><img src="view_button.bmp" /><br /><br />
171<a name="figure6"><u>Figure 6: View Results</u></a><br /><br />
172</p>
173
174
175</body>
176</html>
Note: See TracBrowser for help on using the repository browser.