Changeset 751

Timestamp:

Dec 4, 2009 5:11:24 PM (14 years ago)

Author:

toby

Message:

# on 2003/11/13 17:31:03, toby did:
revise to remove info about TCLDUMP (now standard in GSAS)
revise CMPR/LOGIC references

File:

• trunk/doc/liveplot.html (modified) (17 diffs, 3 props)

trunk/doc/liveplot.html

@@ -40 +40 @@
 <P>
 Both LIVEPLOT and BKGEDIT get the current diffraction information 
-by running the TCLDUMP program, if installed, or
-HSTDUMP otherwise. The TCLDUMP program has been optimized for use 
-with LIVEPLOT and offers a number of extra 
+by running the GSAS TCLDUMP program, if installed, or
+the GSAS HSTDUMP otherwise. The TCLDUMP program has been optimized for use 
+with LIVEPLOT and allows LIVEPLOT to offer a number of extra 
 options that are not available when HSTDUMP is used. Since TCLDUMP has been 
-included in GSAS since April of 2000, it is assumed that this is now the case.
+included in GSAS since April of 2000, the following documentation assumes 
+that TCLDUMP is installed.
 
 <a name="liveplot"></a>
@@ -54 +55 @@
 <UL>
 <LI>The plot is updated automatically after each refinement run
-<LI>The plot can be zoomed, by clicking on the corners of the 
-area to be magnified.
+<LI>The plot can be "zoomed-in", by clicking on the corners of the 
+area to be magnified and "zoomed-out" using the 
+right mouse button (Mac: Apple+click)
 <LI>
 The units used for plotting histograms can be selected. Choices are: 
@@ -71 +73 @@
 Reflection indices (<I>hkl</I> values) can be shown for tickmarks 
 <LI>
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
+<IMG SRC="note.gif" alt="Note!">
 The cumulative chi<sup>2</sup> function can be plotted.
 <LI>
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
+<IMG SRC="note.gif" alt="Note!">
 The cursor position can be displayed
 <LI>
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
+<IMG SRC="note.gif" alt="Note!">
 Plots can be <a href="#export">exported to obtain publication-quality
 graphics.</a>
@@ -84 +86 @@
 <a name="bkgedit"></a>
 <H3>BKGEDIT</H3>
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
+<IMG SRC="note.gif" alt="Note!">
 BKGEDIT is used to fit a background function to a set of points
 selected by the user.
@@ -108 +110 @@
 is good enough for the initial stages of refinement and that can be 
 refined once the model is adequate for the task.
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
+<IMG SRC="note.gif" alt="Note!">
 BKGEDIT can be used to fit GSAS background functions 1-6 (though
 for most purposes only type 1 is needed.)
@@ -248 +250 @@
 <B>Plot contents:</B>
 Reflection markers can be placed using the File/Tickmarks menu item
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">or by pressing the
+<IMG SRC="note.gif" alt="Note!">or by pressing the
 "1" key for phase 1, "2" for phase 2,... Note that many attributes 
 for reflection markers can be edited using 
@@ -254 +256 @@
 
 <P>
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
+<IMG SRC="note.gif" alt="Note!">
 If more than one histogram is available to plot, it is possible to cycle 
 between the histograms by pressing the "n" or "N" (for next) key.
@@ -271 +273 @@
 If the right mouse button is pressed, the previous zoom setting is used, 
 so that the left mouse button is used to "zoom in" and the right mouse
-button is used to "zoom out."
-<P>
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
+button is used to "zoom out." Note, on the Macintosh, hold down the 
+Apple button while using the [only] mouse button to simulate a right-click.
+
+<P>
+<IMG SRC="note.gif" alt="Note!">
 Zoom settings can also be entered manually by pressing the "Z" key. This 
 opens a dialog, as is shown to the right, where the x- or y-axis range
@@ -283 +287 @@
 <a name="LiveCursor"></a>
 <img SRC="cursor.gif" align=RIGHT alt="LIVEPLOT live cursor">
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
+<IMG SRC="note.gif" alt="Note!">
 <B>Cursor Display:</B>
 Pressing the "L" (or "l") key, or using the Option/Show Cursor Position
@@ -335 +339 @@
 <P>
 <a name="export"></a>
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36>
+<IMG SRC="note.gif" alt="Note!">
 <B>Export plot options</B>
 <UL><LI>
@@ -367 +371 @@
 <DD>Checkbuttons are provided for each phase to determine if tick marks
 will be shown. 
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">Tickmarks can also be 
+<IMG SRC="note.gif" alt="Note!">
+Tickmarks can also be 
 toggled by pressing the
 "1" key for phase 1, "2" for phase 2,...
@@ -376 +381 @@
 <DD>This allows a histogram to be selected to be loaded
 <DL><DL>
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
+<IMG SRC="note.gif" alt="Note!">
 It is also possible to advance
 between the histograms by pressing the "n" or "N" (for next) key.
@@ -395 +400 @@
 <A name="grace">
 <DT>to Grace
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36>
+<IMG SRC="note.gif" alt="Note!">
 <DD>Plots can be exported to 
 <A HREF="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://plasma-gate.weizmann.ac.il/Grace/">Grace</A>, WYSIWYG 2D plotting tool for X-Windows
@@ -422 +427 @@
 bottom to the top of the plot. 
 <DT>Label by name
-<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
+<IMG SRC="note.gif" alt="Note!">
 <DD>
 By default, a label "Phase1",... is displayed in the legend when tickmarks
@@ -506 +511 @@
 (or <FONT FACE="COURIER">c:\gsas.config</FONT>)
 files.
-Note that some of these options are relevant only if the tcldump program is 
-present. 
 <DL><DL>
 <DT><FONT FACE="COURIER">peakinfo(flag<i>n</i>)</FONT><DD>
@@ -577 +580 @@
 The time in seconds before reflection labels are removed. A value of zero means that reflections
 must be deleted manually (Shift-Right-Mouse).
-
+(Mac: Shift+Apple+click)
 <DT><FONT FACE="COURIER">expgui(lblfontsize)</FONT><DD>
 A size for reflections labels in pixels.
@@ -589 +592 @@
 </DL></DL>
 <P>
-<hr><H2>Installation details/External Programs</H2>
-<B>Using TCLDUMP with LIVEPLOT.</B>
-LIVEPLOT works with the standard GSAS program HSTDMP, but it works faster and is more
-powerful when used with the TCLDUMP program. 
-Note that as of the April 2000 releases, GSAS is now distributed with TCLDUMP
-included. For older versions of GSAS, note the 
-instructions for downloading this file can in the installation notes for 
-<A HREF="expgui_Win_readme.html">
-Windows</A> and
-<A HREF="expgui_Unix_readme.html">
-UNIX</A>. 
-<P>
-
-<B>Combining CMPR and LIVEPLOT.</B>
-If you have <A HREF="http://www.ncnr.nist.gov/programs/crystallography/software/cmpr">CMPR</A>
-installed on your computer, you can use superimpose on the GSAS results 
-the peaks for an arbitrary unit cell. If desired, space group extinctions 
-can even be shown.
-This is pretty neat! To enable this feature, you must have a version 
-of CMPR downloaded after 4 May 1998 
+<hr><H2>Interfacing External Programs</H2>
+<IMG SRC="new.gif" alt="New!">
+<B>Combining LIVEPLOT with CMPR & LOGIC</B>
+If you have the 
 <A HREF="http://www.ncnr.nist.gov/programs/crystallography/software/cmpr">
-(see link for CMPR installation instructions.)</A>
-<UL><LI>
-For UNIX, create a link from in the EXPGUI
-directory to file cellgen.tcl in the CMPR directory. For example:
-<FONT FACE="COURIER"><PRE>
-   ln -s /usr/local/cmpr/cellgen.tcl /usr/local/gsas/expgui/cellgen.tcl 
-</PRE></FONT>
-<LI>For Windows, copy all the .tcl and .exe files from the CMPR directory
-into the EXPGUI directory.
-</UL>
-<P>
-
-<B>Combining LOGIC and LIVEPLOT.</B>
-If you have <A HREF="http://www.ncnr.nist.gov/programs/crystallography/software/logic.html">LOGIC</A>
-installed on your computer, you can superimpose peaks
-for a entry from the ICDD/JCPDS database on a pattern in LIVEPLOT.
-This is also pretty neat! 
-To enable this feature, you must have 
-a version of LOGIC downloaded after 4 May 1998 
-<A HREF="http://www.ncnr.nist.gov/programs/crystallography/software/logic.html">
-(see the LOGIC installation instructions.)</A>
-<UL><LI>
-For UNIX, create a link from in the GSAS GUI 
-directory to file icddcmd.tcl in the LOGIC directory. For example:
-<FONT FACE="COURIER"><PRE>
-   ln -s /usr/local/powdersuite/icddcmd.tcl /usr/local/gsas/expgui/icddcmd.tcl 
-</PRE></FONT>
-<LI>For Windows, copy all the LOGIC files into the EXPGUI directory.
+CMPR/LOGIC</A>
+programs installed on your computer, you can use superimpose on the 
+GSAS results the peaks for an arbitrary unit cell.
+If you have the 
+<A HREF="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.icdd.com/products/overview.htm">
+ICDD-JCPDS PDF-2 powder diffraction database</a>, 
+you can also superimpose entries from this database on the 
+GSAS results displayed in LIVEPLOT. 
+<P>
+When the CMPR/LOGIC program is installed in the same location
+as the GSAS package (<i>e.g.</i> 
+<font face="courier">/home/gsas</font> & 
+<font face="courier">/home/cmpr</font>
+or <font face="courier">C:\DIFRC\GSAS</font> & 
+<font face="courier">C:\DIFRC\CMPR</font>) or if 
+the CMPR/LOGIC programs are loaded into standard locations 
+(<font face="courier">/usr/local/cmpr</font> or 
+<font face="courier">~/cmpr</font> for Unix and Mac OSX or 
+<font face="courier">c:\cmpr</font> or 
+<font face="courier">c:\Program files\cmpr</font> for Windows), 
+the LIVEPLOT program will locate both programs and add an extra menu labeled
+"Peak Gen" to the menu bar. If the CMPR program is not located automatically,
+you may customize this location by specifying a value for 
+Tcl/Tk variable cmprdid by including a line such as this:
+<PRE>
+          set cmprdir C:/ncnrpkg/cmpr
+</PRE>
+ in the <FONT FACE="COURIER">localconfig</FONT>, 
+<FONT FACE="COURIER">.gsas_config</FONT> 
+or <FONT FACE="COURIER">c:\gsas.config</FONT> files 
+[note that forward slashes ("/") should be used here, even for windows.]
+
+<P>
+The "Peak Gen" menu will have either or both of two entries 
+"Display a cell" and "Plot ICDD Entry", depending on what 
+software is located. The
+"Display a cell" option produces a window similar to the
+<A href="http://www.ncnr.nist.gov/xtal/software/cmpr/doc/cmprdoc.html#editcell">
+Edit Cell feature in CMPR</A>
+where allowed reflection positions are displayed for a set of unit cell 
+parameters and optionally a space group or extinction conditions.
+The "Plot ICDD Entry" provides a window similar to the 
+<A href="http://www.ncnr.nist.gov/xtal/software/cmpr/doc/cmprdoc.html#editcell">
+LOGIC interface in CMPR</A>
+where ICDD searches may be conducted. From the resulting list of matches,
+selected entries may be displayed.
+<P>
+Note that these routines display peak positions in units of 2Theta, Q or
+d-space. If you are using TOF or EDS data, you must select Q or d-space 
+display in LIVEPLOT. If you are using 2Theta, you must supply the correct
+wavelength.
+<P>
+Note that a version of both EXPGUI and CMPR/LOGIC from November 2003 or later 
+must be used for these features to work.
+
 </UL>
 <hr>