USGS

Isis 2 Documentation


getkey Documentation

getkey - Get keyword value(s) from a cube file label
"getkey" will retrieve a user-specified keyword value(s) from
the label of a cube file and return the value(s) to a procedure.

NOTE:  GETKEY can only be called from within a procedure

PROGRAMMER:  Jim Mathews, USGS, Flagstaff

ParmDescriptionDefault
FROM
Input cube file name
 (default extension = .cub)
NONE
OBJNAM
Object name
--
GRPNAM
Group name
--
KEY
Name of the keyword
NONE
KEYTYPE
Keyword type character
  (C, I, R, S, or L)

The remaining parameters are
output only
"S"
KEYVAL
Keyword value(s) returned
NONE
NVALS
Number of values returned
NONE

ADDITIONAL NOTES:

ParmDescription
FROM
Input cube file name.  If the file extension is omitted,
then ".cub" will be assumed.
OBJNAM
Enter the object name from the label of the cube file.
You can find out the object name by running the labels
program or by looking at the cube file label with the
"more" command.
GRPNAM
Enter the group name in the label of the cube file.
You can find out the group name by running the labels
program or by looking at the cube file label with the
"more" command.
KEY
Enter the keyword that will be used to retrieve the
value of in the label of the cube file.
KEYTYPE
Enter a keyword type character.  The valid values are "C",
"I", "R", "S", and "L".  "C" is for a character keyword,
"I" is for an integer keyword, "R" is for a real keyword,
"S" is for a string keyword, and "L" is for a literal
keyword.  If "C" is entered, the value(s) returned will
be an exact copy of what is contained in the cube label.
This includes the double quote marks.  If you do not
wish to have the double quote marks returned, use "S"
instead of "C".
KEYVAL
Value(s) for KEY to be returned to the calling procedure.
This is a 128 character variable.
NVALS
Number of values returned to the calling proc

Last updated: Jan 31 2005
File: pdfs2.html

Contact us online at the Isis Support Center: http://isisdist.wr.usgs.gov

ISIS Documentation Home Page