source: sasview/fittingview/src/sans/perspectives/fitting/media/batch_help.html @ 6a83ba4

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 6a83ba4 was ec538c7, checked in by Gervaise Alina <gervyh@…>, 13 years ago

add help for batch
  • Property mode set to 100644
File size: 7.3 KB
Line 
1<html>
2<head>
3</head>
4
5
6<body>
7<h4> Batch Fit </h4>
8
9<ul>
10<li><a href="#fitpage">Single Fit</a></li>
11<li><a href="#batchwindow">Batch Window</a></li>
12</ul>
13
14<h5><font color="blue"><a name="fitpage">Single Fit</a></font></h5>
15<p>
16Create <b>Batch Page </b> by selecting <b>Batch </b> radio button on
17Data Explorer<font color="blue"><a href="#batch_button">(see figure below)</a></font>.<br />
18
19<br /><img src="batch_button_area.bmp" /><br /><br />
20<a name="figure1"><u>Figure 1: MenuBar</u></a><br />
21
22Load Data to Data Explorer.Activate the <b>Fitting application</b>
23either by selecting "Fitting" from combo box of the Data Explorer window or the menubar item  "Applications".
24Send selected data to fit <font color="blue"><a href="load_data_help.html">(see Load Data help)</a></font>.
25Modify the model parameters as need <font color="blue"><a href="single_fit_help.html">(see single fit help)</a></font>.
26Select a new data from the Data combo box to see analyse
27theory plot. Then click on fit button.
28</p>
29
30<h5><font color="blue"><a name="batchwindow">Batch Window</a></font></h5>
31<p>
32Batch Window provides an easy way to view fit results, plot data, theory, and residuals after a batch fit is completed.
33Batch window will be automatically shown after a batch fit is finished. <br />
34Once closed,
35it can be opened anytime from the "View" menubar item <font color="blue"><a href="#figure2">(see Figure 2)</a></font>.<br />
36
37<br /><br /><img src="restore_batch_window.bmp" /><br /><br />
38<a name="#figure2"><u>Figure 2: Edit Menu</u></a><br />
39  <ul>
40        <li> <a href="#edit_grid"> Edit Grid </a></li>
41        <li><a href="#save_grid"> Save Grid </a></li>
42        <li><a href="#load_batch"> Open Batch Results </a></li>
43        <li><a href="#plot"> Plot </a></li>
44        <li><a href="#view"> View Column/Cell(s) </a></li>
45   </ul>
46</p>
47
48
49<h5><font color="blue"><a name="edit_grid"> Edit Grid </a></font></h5>
50<p>
51Once a batch fit is completed all fitted and fixed model parameters are displayed to the current sheet of
52the batch window, except errors on parameters. To view errors on fitted parameters or data parameters,
53click on a given column then under <b> Edit </b> menubar item and insert the desired parameter by selected
54a menu item with the appropriated label. Empty column can be inserted in the same way.
55Column value can be customized by editing an existing empty column.<br />
56To Remove column from the grid, selected it, click on edit menu, and click on <b> remove </b>  menu item.
57Any removed column should reinserted when needed.<br />
58All above options are also available when right clicking on a given column label
59<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 />
61
62<img src="edit_menu.bmp" /><br /><br />
63<a name="figure3"><u>Figure 3: Edit Menu</u></a><br />
64</p>
65
66
67<h5><font color="blue"><a name="save_grid"> Save Grid </a></font></h5>
68<p>
69To 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>
71menu 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
73will be lost  when reloading the saved file.<br />
74
75<font color="red">Warning! To ensure accuracy of saved fit results, It is recommended to save the current grid
76before modifying it . </font>
77</p>
78
79
80<h5><font color="blue"><a name="load_batch"> Open Batch Results </a></font></h5>
81<p>
82Any <b> csv </b> file can be opened in the grid by selecting <b> Open </b> 
83under <b> File</b> menu <font color="blue"><a href="#figure4">(see Figure 4)</a></font>.
84All columns in the file will be displayed but insertion will not available.
85Insertion will be available only when at least one column will be
86removed from the grid.
87
88<br /><img src="file_menu.bmp" /><br /><br />
89<a name="figure4"><u>Figure 4: MenuBar</u></a><br />
90</p>
91
92
93<h5><font color="blue"><a name="plot"> Plot </a></font></h5>
94<p>
95To <b> plot </b> a column versus another,
96select one column at the time, click on <b> Add </b> button next to text control
97 of X/Y -axis <b> Selection Range </b>
98to plot the value of this column on the X/Y axis.
99Repeat the same procedure the next axis.Finally , click on <b> Plot </b> button.
100When clicking on <b> Add </b> button, the grid
101will automatically fill the axis label, but  different labels and units can be
102entered  in the correct controls before clicking
103on the plot button.<br />
104<b>X/Y -Axis Selection Range </b> can be edited manually. These text controls
105allows the following types of expression:<br />
106
107operation can be <font color="#00CC33"><b>+</b></font>,<font color="#00CC33">
108<b> -</b></font>, <font color="#00CC33"><b>*</b></font>,
109<font color="#00CC33"><b>/</b></font>, or <font color="#00CC33">pow</font>.<br /> <br />
110
1111) if the current axis label range is a function of 1 or more columns,
112 write this type of expression: <br />
113constant1  * <font color="#CC9933">column_name1</font>
114<font color="blue">[minimum row index :  maximum  row index]</font> 
115<font color="#00CC33">operator</font>  constant2 <font color="#00CC33">
116<b>*</b></font> <font color="#CC9933">column_name2</font>
117<font color="blue">[minimum row index :  maximum  row index]</font> <br />
118Example : <font color="#CC9933">radius</font>[2 : 5]<font color="#00CC33"><big><
119b> -</b></big></font> 3 <font color="#00CC33"><b>*</b></font>
120 <font color="#CC9933">scale</font>[2 : 5] <br /><br />
121
1222) if only some value of a given column are need but the range between
123the first row and last row used is not continuous,<br />write
124the following expression in the text control: <br />
125<font color="#CC9933">column_name1</font>
126<font color="blue">[minimum row index1 :  maximum  row index1]</font>
127<font color="#00CC33"><big><b> , </b></big></font> 
128<font color="#CC9933">column_name1</font>
129<font color="blue">[minimum row index2 :  maximum  row index2]</font> <br />
130Example : <font color="#CC9933">radius </font><font color="blue"> [2 : 5] </font>
131<font color="#00CC33"><big><b> , </b></big></font><font color="#CC9933">radius </font>
132 <font color="blue">[10 : 25] </font><br /><br />
133
134
135<b>Note: </b>Both text controls ( X and Y -axis Selection Range) need to be filled
136with valid entries for plotting to work <font color="blue"><a href="#figure5">(see Figure 5)</a></font>.
137
138<br /><br /><img src="plot_button.bmp" /><br /><br />
139<a name="figure5"><u>Figure 5: Plotting</u></a><br />
140
141</p>
142
143
144<h5><font color="blue"><a name="view"> View Column/Cell(s) </a></font></h5>
145<p>
146Select 1 or more cell from the same column, click <b>View Results</b>
147button  to display available curves.
148For example selecting cells of <b> Chi2 </b> column, then click on <b> view </b> 
149button. The plots generates will represent <b>residuals </b> plots. <br />
150
151If 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 />
154
155<br /><br /><img src="view_button.bmp" /><br /><br />
156<a name="figure6"><u>Figure 6: View Results</u></a><br /><br />
157</p>
158
159
160</body>
161</html>
Note: See TracBrowser for help on using the repository browser.