Content-type: text/html Man page of X-GEN


Section: X-GEN Commands (1)
Updated: April 2005
Index Return to Main Contents


X-GEN - setup  


"setup" provides a Curses-based user interface to the X-GEN functionalities. It constructs a shell-level command line for each individual X-GEN programs and then generates a sub-shell to execute that program. Thus the capabilities available from "setup" are by definition identical to those available from running these programs directly from a user prompt. Each program within X-GEN has a Curses screen of controls associated with it. This screen is used to establish the starting values of various run-time inputs to the program--the environment variables that govern the files read and written by the program, and the command-line input associated with it. These command-line inputs are of three types:
"Booleans", which are one-letter modifiers of the command's behavior, and which take on either yes or no values. Each of these is prefixed in the command line by a hyphen, although they may be concatenated in the usual Unix style. Thus
integrate -np
has the same effect as
integrate -n -p
and the Curses interface generates the command in the compact form.
"Switches", which are also prefixed by a hyphen but which take on numerical values that are immediately appended to the letter. Thus a typical switch syntax is
integrate -i0.09
"Parameters", which are pure numeric values without a hyphen. These follow the Booleans and switches in the command. Thus a full specification for a typical X-GEN program run looks like
reduce -exd4 -f-3 -w1 0 0 99 2.8
in which the two zeros, the 99, and the 2.8 are parameters.

The Curses menu established in "setup" can generate and execute commands of this kind.

Specific to "setup" is a menu that manages the environment variables and the frame index for X-GEN. This menu contains a set of values that, properly set, define the three working directories with which X-GEN functions--the "WORK", "DATA" and "SCRT" directories--and the index of images, which has the environment variable FRAMES.

For detectors with time-independent conversions from pixels to centimeters and back again, "setup" examines the images it is working with and copies over a standard pixel-to-centimeter conversion file with suffix .uca into the current working directory for use during data processing. Thus if the run identifier is george and the data come from a Mar 165 CCD detector, then "setup" will, when the user sets up the command files, copy over a standard file marccd.uca into $WORK/george.uca.  


Report bugs to Andy Howard at or 312-567-5881.  


Copyright © 2002, Illinois Institute of Technology. See the file 'LICENSE' for information on usage and redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES




This document was created by man2html, using the manual pages.
Time: 02:08:09 GMT, October 03, 2005