SAOTk Reference Manual
Table of Contents

SAOTk Frame Scale Commands

commands

  • clip scope
  • clip mode
  • clip minmax
  • clip user
  • clip zscale
  • get clip
  • get clip scope
  • get clip mode
  • get clip minmax
  • get clip user
  • get clip zscale
  • has datamin
  • has irafmin

    • clip scope

    Set the scope of clip parameters. This only affects mosaics. The value of LOCAL implies each mosaic segment has its own clip values. The value of GLOBAL implies a max and min of the current clip values of each segment.
    Syntax:  clip scope [local | global]
    Example: clip scope local

    clip mode

    Set the current clipping algorithm. MINMAX uses the min and max values of the image to set the clip low and high values. ZSCALE uses the IRAF zscale algorithm to determine the values. USER allows the user to set the values.
    Syntax:  clip mode [minmax | zscale | user]
    Example: clip mode zscale

    clip minmax

    Set the clip algorithm MINMAX parameters. If the minmax mode is SCAN, the entire image is scanned. A value of SAMPLE implies the image is sampled at a specified increment. A value of DATAMIN implies, the keywords DATAMIN and DATAMAX are used. A value of IRAFMIN implies the keywords IRAFMIN and IRAFMAX are used.
    Syntax:  clip minmax mode [scan | sample | datamin | irafmin] # set min max mode
                   clip minmax param integer # set min max sample increment
    Example: clip minmax mode scan
             clip minmax param 10

    clip user

    Set the clip values.
    Syntax:  clip user numeric numeric
                   clip user low numeric
                   clip user high numeric
    Example: clip user 1 1000
             clip user low 1
             clip user high 1000

    clip zscale

    Set the zscale parameter values. The arguments are contrast, sample size, and sample line.
    Syntax:  clip zscale param numeric integer integer
    Example: clip zscale param .25 600 120

    get clip

    Return the current clip values low high.
    Syntax:  get clip precision
                   get clip canvas coordinate system coordinate precision
    Example: get clip default
             get clip canvas 100 100 default

    get clip scope

    Return the current clipping scope. A value of LOCAL or GLOBAL is returned.
    Syntax:  get clip scope
    Example: get clip scope

    get clip mode

    Return the current clipping mode. A value of MINMAX, ZSCALE, or USER is returned.
    Syntax:  get clip mode
    Example: get clip mode

    get clip minmax

    Return the current minmax parameters.
    Syntax:  get clip minmax mode # returns one of SCAN, SAMPLE, DATAMIN, or IRAFMIN
                   get clip minmax param # returns the sample increment value
    Example: get clip minmax mode

    get clip user

    Return the current user parameters of low and high.
    Syntax:  get clip user
    Example: get clip user

    get clip zscale

    Return the current zscale parameters of contrast, sample size, sample line
    Syntax:  get clip zscale
    Example: get clip zscale

    has datamin

    Returns true if keywords DATAMIN and DATAMAX are available
    Syntax:  has datamin
    Example: has datamin

    has irafmin

    Returns true if keywords IRAFMIN and IRAFMAX are available
    Syntax:  has irafmin
    Example: has irafmin