SYNOPSIS

       xgen [--help] [--version] [--commands] [-hvc] [command]


DESCRIPTION

       "xgen" is a command-line interface to the X-GEN software. It and "xgen-
       tools" replace roughly one  hundred  executables,  each  of  which  was
       intended  to  perform one particular function and then exit. "xgen" and
       "xgentools" are structurally identical software packages; the only dif-
       ference  is  the list of functionalities that are accessible from them.
       "xgen" provides access to  the  fifty  most  important  functionalities
       within  the package; "xgentools" offers access to about fifty less uni-
       versally-required functionalities. The only users  who  are  likely  to
       require "xgentools" are facility managers and developers.

       In  one-line  mode,  the  user executes a single X-GEN command and then
       exits.  In interactive mode, the user types "xgen" and is greeted  with
       a  prompt,  "x>  ".  The user then can type in either X-GEN commands or
       shell  commands,  including  commands  like  "POLARIZATION_TYPE=3"  and
       "source *.com". Filename expansion is accomplished in both cases.

       As  we  have said elsewhere, X-GEN provides for data processing, begin-
       ning at raw images and ending at the creation and analysis of an  ASCII
       file  containing  h,k,l,F,sigma,  and  some  anomalous  information. In
       between it enables

              * determining the pixel-to-centimeter mapping of the detector;

              * finding the active area of the detector;

              * finding a set of reference spots for indexing

              * finding a set of reference model profiles for profile fitting;

              * auto-indexing the data, if needed;

              * refining the unit cell and orientation;

              * integrating the data,

       i.e. determining intensities by profile-fitting and simple summation;

              * filtering the integrated data;

              * merging multiple data runs;

              * scaling the data;

              * eliminating outliers;

              * determining statistical parameters associated with the data;

              * obtaining the ASCII (h,k,l,F,sigma,... ) information.


OPTIONS

       -h, --help
              Print this help file.

       If the next argument is an X-GEN command, the help file associated with
       that X-GEN command is substituted.

       -v, --version
              Print the version number for this application.

       If the next argument is an X-GEN command, the version number of that X-
       GEN command is substituted.

       -c, --commands
              Print the list of available X-GEN commands

       command
              Execute either an X-GEN command or a shell command.

       Among the shell (or pseudo-shell) commands you can execute are declara-
       tions of environment variables, e.g. "POLARIZATION_TYPE=3"; and  sourc-
       ing command files, e.g. "source 83071c.com"


EXAMPLES

       xgen   Start up the interactive X-GEN interface.

       xgen scalem
              Run the X-GEN application `scalem' and exit.

       xgen --help integrate
              Print out the help summary for the

              `integrate' application.

       xgen ls -lai $MULTIREF
              Print the value of the environment variable

       "MULTIREF".


REPORTING BUGS

       Report bugs to Andy Howard at howard@iit.edu or 312-567-5881.


COPYRIGHT

       Copyright  (C)  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




X-GEN application `xgen', VersionDecember 2006 X-GEN(1)



Man(1) output converted with man2html