Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


  >  Docs Center  >  Libraries  >  Motley  >  MGH_GET_CT

MGH_GET_CT

MGH_GET_CT

Name


  MGH_GET_CT

Purpose


  This function reads a colour table file and returns a single
  colour table in the form of a structure.

Calling Sequence


  Result = MGH_GET_CT(table_id)

Positional Parameters


  table_id (input, scalar integer or string)
    The table to be read. If numeric, this argument must be an
    integer, 0 <= table_id <= n_tables. If a string, this argument
    must match one of the tables in the file case-insensitively.

Keywords


  FILE (input, scalar string)
    The name of the colour table file. The default is supplied by
    invoking the function MGH_CT_FILE with the SYSTEM keyword.
  NAMES (input, switch)
    Set this keyword to have the function return a list of
    colour-table names from the file.
  SYSTEM (input, switch)
    This keyword has an effect only if the FILE keyword is not
    specified explicitly--see above.

Return Value


  The function returns an anonymous structure with tags name
  (string), red (256-element byte array), green (ditto) and blue
  (ditto).

Procedure


  Straightforward, adapted from LOADCT.
###########################################################################
  This software is provided subject to the following conditions:
  1. NIWA makes no representations or warranties regarding the
    accuracy of the software, the use to which the software may
    be put or the results to be obtained from the use of the
    software. Accordingly NIWA accepts no liability for any loss
    or damage (whether direct of indirect) incurred by any person
    through the use of or reliance on the software.
  2. NIWA is to be acknowledged as the original author of the
    software where the software is used or presented in any form.
###########################################################################

Modification History


  Mark Hadfield, 1998-08:
    Written.
  Mark Hadfield, 2001-01:
    - Upgraded for IDL 5.5.
    - Added NAMES keyword.
  Mark Hadfield, 2002-12:
    - Upgraded for IDL 5.6.
    - Default colour-table file name now calculated by MGH_CT_FILE.



© 2018 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us