NAME
        WriteSGI

   DESCRIPTION
        This module writes lattices (usually from the Render module) out as SGI
        image files with RLE compression.  It supports one (grayscale), three
        (RGB), and four (RGBA) component lattices with either byte or short
        data values.

   INPUTS

      Input -- Lattice (Opt.)
         (2-D, 1..4-vector, byte..short).
         This is a lattice containing an image.  If it has one component then it
         is interpreted as grayscale.  If it has three components then they are
         interpreted as red, green, and blue.  If it has four components then they
         are interpreted as red, green, blue, and alpha.

   WIDGETS

      Directory -- Text
         This is the directory for the image file.

      Filename -- Text
         This is the name for the image file.

      Extension -- Text
         This is the extension for the image file.

      Full Pathname -- Text
         This is the entire pathname specifying the image file.

      Style -- Option Menu
         This is the style to use when adding the current index number to the
         image name.  The "<n>" notation determines how many digits are used
         and where they are placed in relation to the image name.

      Current -- Slider
         This is the current image index number which can be added to the
         image file's name.

      Increment -- Radio Box
         This determines if the "Current" value is automatically incremented by
         one whenever an image is written out.

      Construct Path? -- Option Menu
         This determines whether "Full Pathname" is constructed from the
         contents of "Directory" + "Filename" + "Extension" or whether it's
         value is taken as whatever is typed into the widget.

      Mode -- Option Menu
         This determines whether any image writing can be done.  In "Build"
         mode, all the widgets can be modified without the image being written.
         It acts as a global "kill" switch.

      Write File! -- Button
         This forces the image to be written if there is data on the input port and
         the full pathname is valid.

   OUTPUTS

      Sync -- Parameter
         This port outputs a "1" value when an image has been written and can
         be used for loop synchronization purposes.

   KNOWN PROBLEMS
      The module may only work on SGI machines because it uses the SGI
      image library for saving the images.  There are no known bugs.

   SEE ALSO
      ExportImage, ImportImage, ScreenImg, WriteImg
      
      -
      
      Hans Vahlenkamp (Hans.Vahlenkamp@noaa.gov)
      Geophysical Fluid Dynamics Laboratory / NOAA
      Princeton University Forrestal Campus
      http://www.gfdl.noaa.gov