source: trunk/doc/expgui.html @ 35

Last change on this file since 35 was 35, checked in by toby, 11 years ago

# on 1999/01/20 21:29:37, toby did:
* empty log message *

  • Property rcs:author set to toby
  • Property rcs:date set to 1999/01/20 21:29:37
  • Property rcs:lines set to +4 -1
  • Property rcs:rev set to 1.3
  • Property rcs:state set to Exp
  • Property svn:keywords set to Author Date Revision Id
File size: 15.0 KB
Line 
1<!-- add lstview liveplot and widplt sections (see tkGSAS.html) --!>
2<html>
3<head>
4<title>EXPGUI</title>
5</head>
6<body>
7
8<center>
9<h1>
10Using EXPGUI</h1></center>
11
12<h2>Introduction</h2> 
13EXPGUI allows two types of actions:
14it allows the different
15GSAS programs such as EXPEDT, GENLES, FOURIER,...
16to be run,
17and it can be used to directly modify the GSAS
18experiment file without using EXPEDT.
19Programs are invoked either through use of the menu bar
20<center><B>
21<br>The menu bar.
22<br><img SRC="menubar.gif" BORDER=3 >
23</center></B>
24or by "pressing" a button on the button bar. The button bar
25simply provides an easy way to access commonly used
26actions on the menu bar. Users can configure the menu
27bar to include their own preferred actions and, with
28some knowledge of the program and Tcl/Tk,
29add their own commands to the menu bar or button bar.
30
31<center><B>
32<br>The button bar.
33<br><img SRC="buttonbar.gif" BORDER=3 >
34</center></B>
35
36<P>
37Different sections of the .EXP file can be edited by selecting different
38panels or pages from the tabbed list. These tabs will have slightly different
39appearance depending on the packages
40available with your local version of Tcl/Tk.
41<center><B>
42<br>The panel tabs using the Tix package.
43<br><img SRC="panebar1.gif"  BORDER=3 >
44</center></B>
45<center><B>
46<br>The panel tabs without the Tix package.
47<br><img SRC="panebar2.gif" BORDER=3 >
48</center></B>
49If the Tix package is loaded on your machine, it will be
50used, but if it is not, EXPGUI will run fine without it.
51<P>
52This documentation will describe the different actions that
53can be accomplished with the different panels and the
54contents of the menus.
55<hr>
56
57<h2>1. LS Controls panel</h2>
58<DL><DL>
59<p>The LS Controls panel shows information about the
60current experiment, typically found in the EXPEDT "Least
61Squares Controls" options.
62<P>
63Note that the order that histograms appear in this
64panel is determined by the "Sort histograms by" option in
65the Options Menu.
66<img SRC="1.gif" align=TEXTTOP>
67</DL></DL>
68<P>
69<h2>2. Phase panel</h2> 
70<DL><DL>
71The phase panel is used to edit information
72about the phase or phases found in the experiment
73file. The cell and atomic damping and refinement
74flags can be changed here. Note that if a
75single atom is selected using the mouse, the information
76for that atom can be edited. If a group of atoms is
77selected
78<A href="#mouseactions">(see Mouse Actions)</A>
79the damping and refinement flags
80for all the selected atom can be changed at one time.
81<P>
82Note that the order that atoms appear in this panel is
83determined by the "Sort Atoms by" option in the Options
84Menu.
85<img SRC="2.gif" align=TEXTTOP>
86</DL></DL>
87
88<h2>3. Histogram panel</h2> 
89<DL><DL>
90The histogram panel is used to edit background
91and diffractometer constants for a histogram, as well as
92set damping and refinement flags for these parameters.
93<P>
94If
95<A href="#multiplehistogram">
96"Multiple Histogram Selection" mode</A> is set to "All",
97this panel is disabled. For other settings of this mode,
98groups of histograms can be selected and modified
99collectively.
100<P>
101Note that the order that histograms appear in this
102panel is determined by the "Sort histograms by" option in
103the Options Menu.
104<img SRC="3.gif" align=TEXTTOP>
105</DL></DL>
106
107<h2>4. Scaling panel</h2> 
108<DL><DL>
109The Scaling panel is used to edit the scale factor for a
110histogram as well as the phase fractions for each phase
111present in that histogram. Damping and refinement flags
112can also be set here.
113<P>
114If
115<A href="#multiplehistogram">
116"Multiple Histogram Selection" mode</A> is set to
117any value other than "Off,"
118groups of histograms can be selected and modified
119collectively.
120<P>
121Note that the order that histograms appear in this
122panel is determined by the "Sort histograms by" option in
123the Options Menu.
124<img SRC="4.gif" align=TEXTTOP>
125</DL></DL>
126
127<h2>5. Profile panel</h2> 
128<DL><DL>
129The Profile panel is used to edit the profile values for
130each phase present in a histogram as well as set
131the refinement flags and a damping value for each phase.
132<P>
133If
134<A href="#multiplehistogram">
135"Multiple Histogram Selection" mode</A> is set to "All",
136this panel is disabled. For other settings of this mode,
137profile values and settings can be collectively
138modified for groups of histograms.
139<P>
140Note that the order that histograms appear in this
141panel is determined by the "Sort histograms by" option in
142the Options Menu.
143<img SRC="5.gif" align=TEXTTOP>
144</DL></DL>
145
146<a name="multiplehistogram">
147<h2>6. Multiple Histogram Selection</h2></a>
148<DL><DL>
149This mode allows parameters to be changed for groups of
150histograms.
151When the "Multiple Histogram Selection" mode is off,
152it is possible to modify parameters
153and refinement flags for only a single histogram, but
154the other settings allow groups of histograms
155to be selected and modified.
156<A href="#mouseactions">(see Mouse Actions)</A>.
157
158It does not make sense, however, to globally modify
159instrument-related parameters and flags for different
160histogram types.
161So global actions can be limited to a single class
162of histogram types (e.g. TOF, CW Neutron,...), which
163allows these parameters to be set for groups of
164similar histograms. Thus, if this mode is set to "All"
165the Histogram and Profile panels are disabled.
166<P>
167The setting for "Multiple Histogram Selection" mode is
168selected using the "Multiple Hist. Selection" item on the
169Options menu.
170<p>
171<a name="mouseactions">
172</DL></DL>
173<h2>7. Mouse Actions</h2></a>
174<DL><DL>
175A range of atoms or (in multiple selection mode) histograms may be
176selected by dragging (holding down) the left mouse button. It is also
177possible to select a range by using the Shift key with the left mouse
178button. To select or deselect individual entries, use the Control key
179with the left mouse button. The right mouse button selects all
180entries.
181</DL></DL>
182
183<h2>8. Menus</h2>
184A description of the EXPGUI menus follows along with a very
185brief description of the function of each menu option.
186Note that an option may appear under more than one menu.
187<H3>8.1 File Menu</H3>
188<DL><DL>
189The options on the File menu as is the custom contains the commands
190for reading and writing experiment files, as well as starting
191and ending the program.
192<DL>
193<DT>
194expnam
195<DD>
196        Select an existing GSAS experiment to be used
197<DT>Save<DD>Saves modifications to the current experiment file to disk
198<DT>Save As<DD>Saves modifications to the current experiment file to disk
199        under a new file name
200<DT>Reread .EXP file<DD>Reread the last saved version of the experiment file from disk.
201<DT>New_expnam<DD>Create a new GSAS experiment from scratch
202<DT>convert<DD>Convert a standard ASCII file to the direct access format used by GSAS (and for UNIX, the reverse)
203<DT>exit<DD>Exit EXPGUI
204</DL>
205<img SRC="m1.gif" BORDER=3 >
206</DL></DL>
207
208<h3>8.2 Options Menu</h3>
209<DL><DL>
210This menu contains options that determine how EXPGUI runs.
211<DL>
212<DT>archive EXP<DD>Toggles archiving of .EXP files. When on, files are
213        saved prior to each save or run of expedt in a file named
214        [expnam].EXP.xxx.gz where xxx = 000, 001 (UNIX)
215        or in a file named [expnam].ZIP or  [expnam].xxx (Windows)
216<DT>Sort atoms by<DD>   Determines the order that atoms are displayed on the "Phase" page
217        Atoms may be displayed sorted by atom number, atom type,
218        or by x, y or z
219
220<DT>Sort histograms by<DD>Determines the order that histograms are displayed on the
221        Histogram, Scaling and Profile pages
222
223        Histograms may be sorted by histogram number, histogram type,
224        original bank number, or diffraction angle/wavelength
225<DT>Multiple hist. selection<DD>When this mode is off, it is possible to modify parameters
226        and refinement flags for only a single histogram. For other settings,
227        it is possible to modify parameters and flags for groups of
228        histograms (see help for Mouse actions).
229
230        It does not make sense, however, to globally modify
231        instrument-related parameters and flags for different histogram types.
232        So global actions can be limited to a single class of histogram types
233        (e.g. TOF, CW Neutron,...), which allows these parameters to be set
234        for groups of similar histograms. Thus, if this mode is set to "All"
235        the Histogram and Profile pages are disabled.
236<DT>Override backspace<DD>This option is available in UNIX only, as there are different
237        ways that backspace can be implemented. When option is set
238        as "On," the backspace key is overridden to send a "delete"
239        character. If backspace does not work in a program such as
240        EXPEDT, change try the other setting for this option.
241<DT>SaveOptions<DD>Save the current values for "Override backspace",
242        "Sort atoms by", "Sort histograms by" and "archive EXP"
243        in file ~/.gsas_config (c:\.gsas_config on Windows).
244<DT>liveplot_options<DD>Used to set options for liveplot,
245for example, the histogram to be plotted
246</DL>
247<img SRC="m2.gif" align=TEXTTOP>
248</DL></DL>
249
250<h3>8.3 Powder Menu</h3>
251<DL><DL>
252This menu contains links to GSAS programs used for powder diffraction
253analysis.
254<DL>
255<DT>expedt<DD>Run GSAS experiment editor
256<DT>powpref<DD>Powder data preparation
257<DT>genles<DD>Run GSAS experiment editor
258<DT>powplot<DD>Display powder patterns
259<DT>rawplot<DD>Plot powder data
260<DT>fitspec<DD>Fit a TOF vanadium scattering spectrum
261<DT>tofnorm<DD>Normalize a TOF spectrum
262</DL>
263<img SRC="m3.gif" align=TEXTTOP>
264</DL></DL>
265
266<h3>8.4 Single Crystal Menu</h3>
267<DL><DL>
268This menu contains links to GSAS programs used for
269single-rystal diffraction analysis.
270<DL>
271<DT>expedt<DD>Run GSAS experiment editor
272<DT>powpref<DD>Powder data preparation
273<DT>scabs<DD>Single crystal absorption
274<DT>scmerge<DD>Sort and merge single crystal data
275<DT>sxtldata<DD>Prepare generic single crystal data
276</DL>
277<img SRC="m4.gif" align=TEXTTOP>
278</DL></DL>
279
280<h3>8.5 Graphics Menu</h3>
281<DL><DL>
282This menu contains links to several GSAS and
283two non-GSAS (liveplot and widplt)
284programs used for graphical display of data and results.
285<DL>
286<DT>forplot<DD>Display Fourier maps (set Fourier options in EXPEDT
287        and then compute with FOURIER
288<DT>polfplot<DD>Display polefigures
289<DT>powplot<DD>Display powder patterns
290<DT>ortep<DD>Draw crystal structure
291<DT>rawplot<DD>Plot powder data
292<DT>fourier<DD>Generate Fourier map
293<DT>forsrh<DD>Search Fourier map for peaks
294<DT>liveplot<DD>Create a plot of powder data
295with zooming, automatic update and other nice features.
296<DT>widplt<DD>Displays the FWHM as a function of Q, 2Theta,... for UVWXY values input or read from an EXP file
297</DL>
298<img SRC="m5.gif" align=TEXTTOP
299</DL></DL>
300
301<h3>8.6 Results Menu</h3>
302<DL><DL>
303This menu contains links to several GSAS and
304one non-GSAS (lstview)
305programs used for analysis of results.
306<DL>
307<DT>bijcalc<DD>Thermal parameter analysis
308<DT>disagl<DD>Distance/angle calculations
309<DT>reflist<DD>List reflection data
310<DT>geometry<DD>Molecular geometry calculations
311<DT>hstdmp<DD>List powder histogram data
312<DT>istats<DD>HKL Intensity statistics
313<DT>rcalc<DD>Compute reflection resuduals
314<DT>lstview<DD>Create a box with scrollbars containing the current .LST file
315</DL>
316<img SRC="m6.gif" align=TEXTTOP>
317</DL></DL>
318
319<h3>8.7 Calculations Menu</h3>
320<DL><DL>
321This menu contains programs for useful crystallographic computations.
322<DL>
323<DT>cllchg<DD>Transform unit cell
324<DT>fprime<DD>Compute f, f', f'' and mu/rho for an element for a range of x-ray wavelengths
325<DT>rducll<DD>Unit cell reduction
326<DT>spcgroup<DD>Space group symbol interpreter
327<DT>unimol<DD>Unique molecule assembler
328</DL>
329<img SRC="m7.gif" align=TEXTTOP>
330</DL></DL>
331
332<h3>8.8 Import/Export Menu</h3>
333<DL><DL>
334This menu contains utilities for importing information into GSAS and
335exporting.
336<DL>
337<DT>gsas2cif<DD>Prepare IUCr crystallographic information (CIF) file
338<DT>hklsort<DD>Prepare HKL tables
339<DT>pubtable<DD>Prepare atom parameter tables
340<DT>convert<DD>Convert a standard ASCII file to the direct access format used by GSAS (and for UNIX, the reverse)
341<DT>cad4rd<DD>Prepare CAD4 single crystal data
342<DT>dbwscnv<DD>Convert a powder diffraction data file from DBWS format
343<DT>x17bcnv<DD>Convert an energy dispersive diffractogram data file from NSLS X17b
344<DT>p3r3data<DD>Prepare Siemens/Brucker P3R3 single crystal data
345<DT>sxtldata<DD>Prepare generic single crystal data
346</DL>
347<img SRC="m8.gif" align=TEXTTOP>
348</DL></DL>
349
350<h2>9. EXPGUI Utility Programs</h2></a>
351<DL><DL>
352<P><B>LSTVIEW</B>
353
354<P>lstview is used to browse through the GSAS output listing. It is
355invoked by the "lstview" command in the GUI.
356<CENTER><IMG SRC="http://rrdjazz.nist.gov/~toby/textview.gif"></CENTER>
357
358
359<P><B>LIVEPLOT</B>
360
361<P>liveplot shows the observed, calculated and difference plots for powder
362refinements. The plot is updated as the refinement progresses. The mouse can
363be used to zoom in on sections of the plot.
364<CENTER><IMG SRC="http://rrdjazz.nist.gov/~toby/liveplot.gif"></CENTER>
365<IMG SRC="new.gif" HEIGHT=13 WIDTH=36>
366LIVEPLOT can now be enhanced to superimpose peak locations for
367input unit cells or peaks from JCPDS/ICDD entries.
368See the <A HREF="http://rrdjazz.nist.gov/~toby/tkGSAS_cfg.html#liveplot">
369LIVEPLOT customization information</A>
370or read file <tt>tkGSAS_cfg.html</tt> in the gsas/tcl directory.
371
372<P><B>WIDPLT</B>
373
374<P>widplt can be used to plot the actual peak widths generated by the profile
375parameters used in GSAS. It is possible to define reference curves
376that are loaded automatically.
377<CENTER><IMG SRC="http://rrdjazz.nist.gov/~toby/widplt.gif"></CENTER>
378<BR> 
379</DL></DL>
380
381<H2>
382Acknowledgements</H2>
383Praise to Larson and <A HREF="http://strider.lansce.lanl.gov/mlnsc/scientists/vondreele.html">Von
384Dreele</A> for GSAS, <A HREF="http://www.scriptics.com/">Ousterhout</A>
385for Tcl/Tk and <A HREF="http://rrdjazz.nist.gov/przemek.html">Przemek Klosowski</A>
386for convincing me to learn Tcl/Tk.
387<hr>
388GSAS is written by Allen C. Larson and Robert B. Von Dreele,  MS-H805,
389Los Alamos National Laboratory, Los Alamos, NM 87545. Problems, questions
390or kudos concerning GSAS should be sent to Robert B. Von Dreele at
391<A HREF="MAILTO:vondreele@lanl.gov">vondreele@lanl.gov</A>
392<P>GSAS is Copyright, 1984-1997, The Regents of the University of California.
393The GSAS software was produced under a U.S. Government contract (W-7405-ENG-36)
394by the Los Alamos National Laboratory, which is operated by the University
395of California for the U.S. Department of Energy. The U.S. Government is
396licensed to use, reproduce, and distribute this software. Permission is
397granted to the public to copy and use this software without charge, provided
398that this notice and any statement of authorship are reproduced on all
399copies. Neither the Government nor the University makes any warranty, express
400or implied, or assumes any liability or responsibility for the use of this
401software.
402<P>EXPGUI is written by Brian H. Toby of the NIST Center for Neutron Research,
403<A HREF="MAILTO:Brian.Toby@NIST.GOV">Brian.Toby@NIST.GOV</A> 
404with help from Jonathan Wasserman.
405
406<P>EXPGUI is not subject to copyright. Have fun with it.
407
408<p>Neither the U.S. Government nor any author makes any warranty,
409expressed or implied, or assumes any liability or responsibility
410for the use of this information or the software described
411here. Brand names cited here are used for
412identification purposes and do not consitute an endorsement by NIST.
413
414<p><a href="http://rrdjazz.nist.gov/~toby/">Brian Toby</a> (<a href="mailto:brian.toby@nist.gov">Brian.Toby@NIST.GOV</a>)
415<br>
416$Revision: 35 $ $Date: 2009-12-04 22:59:17 +0000 (Fri, 04 Dec 2009) $
417</body>
418</html>
Note: See TracBrowser for help on using the repository browser.