
EDITIMAGE(help)              Khoros               EDITIMAGE(help)

     COMMAND LINE OPTIONS

     The full syntax for executing editimage from the command
     line is as follows:

     editimage
             -i  input image filename  (infile)

             [-ov]  overlay image filename (infile) [null]
             [-s]  input shape mask filename (infile) [null]
             [-c]  input clip mask filename (infile) [null]
             [-x]  x value of upper-left corner of image
     (integer, -1 to 1000) [-1]
             [-y]  y value of upper-left corner of image
     (integer, -1 to 1000) [-1]
             [-roi_out]  output ROI filename (outfile) [null]
             [-zoom]  initial zoom factor (float, > 0.0) [2.0]
             [-update]  initial update time (float, >= 0.0) [0.0]
             [-display]  host:display.screen (string) [null]
             [-form]  editimage form (string) [null]
             [-cmap_image]  image with alternate colormap
     filename (infile) [null]
             [-use_cmap]  use colormap? (boolean) [true]

             [-V] Gives the version for editimage
             [-U] Gives the usage for editimage
             [-P] Prompts for command line options
             [-A [file1]] Creates the answer file called
     editimage.ans or file1
             [-a [file1]] Uses editimage.ans or file1 as the
     answer file

     [-i {input image filename}]
          This is the input VIFF image to be displayed, unless
          you prefer to start editimage with no arguments, and
          enter the input VIFF image in the Input/Output pane of
          the "Image Utilities" pulldown menu. The VIFF file may
          be of any data type except complex. It will be the
          currently displayed image.  With multiband images, the
          first (0th) band is displayed by default.  The CHANGE
          BANDS option on the "Display Utilities" pull-down menu
          can be used to display other bands if desired.

     [-ov {overlay image filename}
          If desired, a bit image may be specified to be over-
          layed onto the currently displayed image.  It must be a
          Khoros VIFF file of data type BIT; if the VIFF image
          passed in is NOT of type BIT, it will be automatically
          converted without prompting or warning (this is only
          done internally - the file itself will not be changed).
          ALSO: if the VIFF data file passed in is a multiband
          image, the first (0th) band will be taken as the over-
          lay.

          When an image is overlaid, the overlay image is used as
          an overlay mask; the overlay mask is used to indicate
          which part of the overlay image is transferred onto the
          currently displayed image.  All pixels of the overlay
          mask that have a value of 1 cause the corresponding
          pixels of the overlay image to be transferred onto the
          currently displayed image.  All pixels of the overlay
          mask that have a value of 0 indicate that pixels of the
          currently displayed image at those locations will
          appear normally.  Note that ONLY images of data type
          bit can be used as overlays; If the image to be over-
          laid is not of type bit, it will be internally con-
          verted to type bit, without prompting or warning,
          before it is overlaid.  Note that this conversion will
          not affect the original file in any way.

     [-s {shape mask filename}]
          If desired, a BIT image may be provided to act as a
          shape mask. It must be a Khoros VIFF file of data type
          BIT; if the VIFF image passed in is NOT of type BIT, it
          will be automatically converted without prompting or
          warning (this is only done internally - the file itself
          will not be changed).  ALSO: if the VIFF data file
          passed in is a multiband image, the first (0th) band
          will be taken as the shape mask.

          When an image is used as a shape mask for the currently
          displayed image, the only part of the currently
          displayed image that will be visible is that part
          defined by the pixels in the shape mask image that have
          a value of (1).  All other parts of the currently
          displayed image will "disappear", and the background
          (the part of the screen behind the image display win-
          dow) will show through. Images work best as shape masks
          when they are the same size as the input data.
          $KHOROS_HOME/data/masks/ contains two images that make
          good shape masks.  To get the shape mask to go away,
          NULL out the "Shape Mask" parameter, and hit <cr>.

          WARNING:  ONLY VERY SIMPLE BIT IMAGES SHOULD BE USED AS
          SHAPE MASKS.  For example, the bit image "ball.bit"
          KHOROS_HOME/data/masks is a good shape mask. As more
          complicated images are used (images with many "holes"
          in them), the program will become incredibly slow as
          the X server  has to do much additional work in order
          to map the image to the window.  NOTE: This feature
          will only work on X servers that support the shape
          extension!

     [-c {clip mask filename}]
          If desired, a bit image may be input and used as a clip
          mask.  It must be a Khoros VIFF file of data type BIT;
          if the VIFF image passed in is NOT of type BIT, it will
          be automatically converted without prompting or warning
          (this is only done internally - the file itself will
          not be changed).  ALSO: if the VIFF data file passed in
          is a multiband image, the first (0th) band will be
          taken as the clip mask.

          When an image is used as a clip mask for the currently
          displayed image, the only part of the image that will
          appear normally is that part defined by the pixels in
          the clip mask image that have a value of (1). All other
          parts of the current image will appear in the back-
          ground color of the image window (usually black).
          Images work best as clip masks when they are the same
          size as the input data.  $KHOROS_HOME/data/masks/ con-
          tains two images that make good clip masks.  To get the
          clip mask to go away, NULL out the "Clip Mask" parame-
          ter, and hit <cr>.

     [-x {x value}, -y {y value}]
          If your window manager does not use manual placement,
          or you would like to over-ride the manual placement
          used by your window manager (this may not work with all
          window managers), specify the (x,y) location in device
          coordinates at which you would like the graphical user
          interface to appear.

     [-roi_out {output ROI filename}
          If you intend to use the Region of Interest utility
          found on the "Image Utilities" pulldown menu to output
          a Khoros VIFF file representing a particular region of
          interest, and you know in advance the name of the out-
          put file that you wish to use, you may specify that
          filename here.  When you bring up the "Region of
          Interest" subform,  the "Output Filename" parameter
          will be already filled out with your filename.

     [-zoom {initial zoom factor}]
          If you intend to use the Zoom utility found on the
          "Display Utilities" pulldown menu to zoom in on the
          currently displayed image, and you know in advance the
          zoomfactor that you wish to use (the default is 2.0),
          you may specify the zoomfactor here. When you bring up
          the "Zoom" subform, the zoomfactor will be already set
          to your desired value.  It must be specified as a
          floating point value which must be greater than zero.

     [-update {update time}]
          Suppose that while you are displaying an image with
          editimage, the Khoros VIFF file that is currently
          displayed is over-written.  When the [-update] flag is
          specified as some number greater than zero (the
          default), this indicates to editimage that it should
          automatically register the fact that the input file has
          been changed, and update the currently displayed image
          accordingly.  The value of the [-update] flag specifies
          (in seconds) how often the input file is to be checked
          for any potential modifications.    It should be speci-
          fied as a floating point value which is greater than
          zero.  When the value of the [-update] flag is zero
          (the default value), editimage will NOT check the input
          file for modifications.

     [-display {display}]
          You may execute editimage on one workstation, but
          display it on another.  If you wish to do this, you
          must specify the display on which editimage will
          appear.  It must be specified as "-display
          host:screen".

     [-form {UIS FILE}]
          If desired, you may copy the User Interface Specifica-
          tion for editimage
          (KHOROS_HOME/repos/editimage/editimage.form) and change
          the geometry specifications, labels, or defaults
          according to your personal preferences. Now, if you
          specify "-form new.form" where new.form is your per-
          sonal UIS file, the graphical user interface of editim-
          age will be defined by your UIS file. Note: it is not
          advisable to do this unless you are very familiar with
          the syntax and definition of all lines in the UIS file.
          Furthermore, you may not add or delete any lines from
          the UIS file.  Geometry strings, labels, and defaults
          are the only fields that may be changed.  Any other
          changes will corrupt the UIS file, and editimage will
          not work.

     [-cmap_image {VIFF image w/ alternate colormap}]
          If desired, another image may be input, and its color-
          map will be used with the currently displayed image,
          instead of the currently displayed image's colormap.

     [-use_cmap {t/f}]
          While the default action of editimage is to use the
          colormap associated with the currently displayed image,
          no colormap is required to be used. If the colormap
          associated with the currently displayed image is not
          wanted, AND the "-cmap_image filename" is not used,
          specify "-use_cmap 0", or "-use_cmap false".  In this
          case, the default colormap associated with the screen
          on which editimage is being run will be used. NOTE:
          when "Use Colormap" is specified as false, the [-
          cmap_image] option detailed above WILL NOT TAKE EFFECT.

     Version
          The "-V" argument will print out the current version of
          editimage.

     Usage
          The "-U" argument will print out the usage for editim-
          age, in much less detail than is given here.

     Interactive Prompting
          The "-P" argument will give interactive prompting for
          each of the arguments listed above.

     Creating an Answer file
          The "[-A {filename.ans}]" argument will create an
          answer file named "filename" if the filename option is
          specified, or named "editimage.ans" if no filename is
          given.  An answer file stores the values specified of
          all arguments listed above.  Note: the "-A" argument is
          usually used in conjunction with the "-P" argument.

     Using an Answer file
          The "[-a {filename.ans}]" argument will use the answer
          file named "filename" if the filename option is speci-
          fied, or named "editimage.ans" if no filename is given.
          Editimage will use the answer file to get values for
          all arguments listed above.  No other arguments should
          be necessary when the "-a" argument is used.

          Copyright 1991, University of New Mexico. All rights
          reserved.

Khoros                    Release: 1.0                          1

