• shSaoMaskDisplay
  • shSaoMaskColorSet
  • shSaoMaskGlyphSet
  • saoMaskDisplay.c

       This file contains the routines used to display a mask on FSAO through
       C.
     
    
    
    

    shSaoMaskDisplay

    DESCRIPTION:
    
    This routine will display a mask in the requested fSAO display. The mask is not altered in any way but is sent as is to fSAO. The lookup table is used by fSAO to translate mask values to one of the colors as set by saoMaskColorSet. In addition -
  • A copy of FSAOimage must be running.
  • The command saoMaskColorSet must have been executed. (Or the equivalent C routine shSaoMaskColorSet called.
  • The specified mask must be the same size as the region currently being displayed.
  • After calling this routine the masked region is displayed immediately. Clicking on the right mouse button (on a right handed mouse) will toggle between displaying the masked region and the unmasked region. FSAO must be in SCALE mode for this to work. NOTE: this means the right mouse button cannot be used for blinking.
    RETURN VALUES:
       SH_SUCCESS           - Successful completion
       SH_NO_COLOR_ENTRIES  - The Tcl command saoMaskColorSet was not executed or
                              the routine shSaoMaskColorSet was not called.
       SH_SIZE_MISMATCH     - The mask is not the same size as the displayed
                              region.
       SH_SAO_NUM_INV       - Invalid saoindex specified.
       SH_NO_FSAO           - No fSAO process associated with this process.
       SH_RANGE_ERR         - Saoindex value is too large.
       SH_PIPE_WRITE_MAX    - Could not write to fSAO process.
       SH_PIPE_WRITEERR     - Error writing to pipe.
    
    
    SIGNATURE:
      RET_CODE shSaoMaskDisplay
         (
          char *a_maskData,	/* IN: Pointer to area of memory where the mask
                                     data is stored. */
          MASK *a_maskPtr,	/* IN: Pointer to themask structure. */
          char  a_maskLUT[LUTTOP], /* IN: Mask lookup table. */
          int  a_saoindex	/* IN: The sao number of where to display mask. */
         )
    

    shSaoMaskColorSet

    DESCRIPTION:
    
    This routine allows the user to specify the colors to be used when displaying the mask in FSAO. The color names should be those recognized by X (e.g. RED, BLUE, GREEN...) and are not case sensitive. It should be noted that X color names may differ from machine to machine. An exact color match is not guaranteed. An attempt will be made to get the closest available color to the requested color. The specified colors will be used to display all masks until this command is entered with new color values.

    Eight colors (plus transparent) can be used to display a mask. By default, the mask color on a monochrome display is white.

    RETURN VALUES:
       SH_SUCCESS            - Successful completion.
       SH_NAMES_TOO_LONG     - The total size of the string containing all the
                               specified color values is too long.
    
    SIGNATURE:
      RET_CODE shSaoMaskColorSet
         (
          char **colorList	/* IN: argv style argument where each pointer points
                          	       to a string specifiying a specific color. */
         )
    

    shSaoMaskGlyphSet

    DESCRIPTION:
    
    This routine allows the user to specify the glyph to be used when displaying the mask in FSAO. The glyph is displayed when the image is magnified larger than lifesize. The possible glyphs are M_GLYPH_X or M_GLYPH_BOX. This routine can be called only after FSAO is started with shSaoMaskDisplay and applies only to that FSAOimage. By default, FSAO uses the M_GLYPH_X glyph.
    RETURN VALUES:
       SH_SUCCESS            - Successful completion.
       SH_SAO_NUM_INV       - Invalid saoindex specified.
       SH_NO_FSAO           - No fSAO process associated with this process.
       SH_RANGE_ERR         - Saoindex value is too large.
       SH_PIPE_WRITE_MAX    - Could not write to fSAO process.
       SH_PIPE_WRITEERR     - Error writing to pipe.
    
    SIGNATURE:
      RET_CODE shSaoMaskGlyphSet
         (
          int  a_glyph,	/* IN: the glyph to use. */
          int  a_saoindex	/* IN: The sao number of where to display mask. */
         )