USGS

Isis 2 Documentation


labels Documentation

labels - Lists or modifies CUBE or TABLE file labels
This program lists information about various data objects described in
the label of an ISIS CUBE file or an ISIS TABLE file.  It lists a
summary of each data object, the keyword labels, the history object or
all of these.

The summary contains the name and size (in 512-byte records) for each
data object.  If the file is a CUBE file (contains a HISTORY and a CUBE
object), then a summary of the important characteristics of the CUBE
object is included.

The object description for each data object is examined to determine if
it is a standard ISIS TABLE object.  This is done by checking the
OBJECT_TYPE keyword.  If it exists and has the value ISIS_TABLE, then a
summary of the TABLE object is produced.  (One or more TABLE objects can
be included as "extra" objects in a QUBE file.  Or, TABLE objects can
be stored in files that are not QUBE files.)  The summary includes the
number of rows of table data that are currently stored in the object
(given by the ROWS keyword) and the total number of rows that could
fit in the allocated object size.  It also includes the row size that is
currently defined (by the COLUMNS, COLUMN_NAME, COLUMN_ITEMS,
COLUMN_ITEM_BYTES, COLUMN_ITEM_TYPE, and COLUMN_ITEM_FORMAT keywords)
and the total size allocated for each row (given by the ROW_BYTES
keyword).  The summary also lists the following information for each
defined column in the TABLE: column name, data type (INTEGER, REAL, or
CHARACTER), size (number of bytes used for storing a single column
element value in binary format), number of elements (which is 1 for a
scalar column value or the total number of values if the column is an
array), and the default format to be used for converting a column
element from binary to ASCII format (expressed as a Fortran format
specifier).  Note that the "tbl2asc" program can be used to produce a
listing of the data values contained in a TABLE object.

The keyword label area contains information needed
to process the image.  Keywords are in the form, 'keyword=keyvalue'.  An
example, TARGET=MIRANDA.  The HISTORY object contains a list of the
processing which has been done on the image and some parameters.

"labels" also allows you to add a new label keyword, change the value of
an existing keyword or delete a keyword.  The keyword can be added to
the labels of a qube or a table file depending on the value of the OBJECT
parameter.  LABELS will also allow you to initialize the HISTORY object,
which will set this area to blanks.  When the HISTORY object becomes
full, it can be initialized with INITHIST=YES.  See the ISIS System
Design (ISD) manual for more information about PDS labeled files.

Programmer:  Tracie Sucharski, U.S.G.S, Flagstaff

ParmDescriptionDefault
FROM
Input cube file name
  (Default extension is .cub)
NONE
LIST
List option
(SUMMARY, KEYWORD, HISTORY, ALL,
 NONE)
KEYWORD
DEST
Destination for listing:
  TERM, FILE, BOTH
"BOTH"
LISTFILE
Name of output list file
  (default extension is .lis)
" "
BAND
List BAND_BIN keywords
(YES, NO)
YES
INITHIST
Initialize HISTORY object
(YES, NO)
NO
OBJTYP
Object where keyword is
to be updated
"QUBE"
KEYWORD
Keyword that is to be added
or updated
--
KEYVALUE
Keyword value
--
KEYVFILE
Name of file containing list
of keyvalues.
--
KEYINDEX
Indices into multi-valued
keyword.
--
GRPNAM
Group for keyword
--
KEYTYPE
Keyword type
 (STRING, LITERAL, INTEGER,
  REAL, DOUBLE)
--
DELETE
Keyword to be deleted
--

ADDITIONAL NOTES:

ParmDescription
FROM
Input cube file name.  If the file extension is omitted,
then ".cub" will be assumed.
LIST
Indicates which label areas to list.  Possible values are:

SUMMARY will list a brief summary  of the labels information
in the file.  (This is always included in the listing.)

KEYWORD will list the label summary plus a listing of the
keyword label area.

HISTORY will list the label summary plus a listing of the
History object,

ALL will list all of the above.
DEST
Destination for the listing.  The following options are
available:

TERM specifies that the listing is to be output only to the
controlling terminal.

FILE specifies that the listing is to be output only to a
disk file.

BOTH specifies that the listing is to be output to both the
controlling terminal and a disk file.

If the listing is to be put into a disk file, then the
LISTFILE parameter specifies the name of the file.  If no
LISTFILE is specified, then the listing is put into the
ISIS session log file.
LISTFILE
Name of the output list file.  If no file extension is
specified, then an extension of ".lis" will be used.

If this parameter is specified as the null string (i.e.,
all blanks), then the listing is put into the ISIS session
log file (print.prt) rather than in a separate disk file.

This parameter is used only when the destination is
specified as DEST=FILE or DEST=BOTH.
BAND
Indicates whether keywords beginning with BAND_ are listed.
If NO, keywords beginning with BAND_ will not be listed.
INITHIST
Indicates whether to initialize the HISTORY object to all
spaces.  This can be used when the HISTORY object becomes
full.
OBJTYP
Object where keyword is the be updated.  This can be set
to "QUBE" or "TABLE".
KEYWORD
This contains the name of the keyword that is to be updated
in the keyword label area.  Note:  This program will not
allow keywords in the IMAGE_MAP_PROJECTION group to be
updated.
KEYVALUE
This contains the keyvalue that goes along with the keyword
that is to be added or updated in the keyword label area.
If the keyword has more than one value, enter them as
string values separated by commas.
Ex:  KEYWORD=TARGET_NAME, KEYVALUE=MIMAS will change the
target to MIMAS.
KEYVFILE
Name of a file which contains a list of keyvalues
corresponding to the labels keyword given in "KEYWORD".
TAE only allows up to 50 values to be entered in a
parameter.  Specify8ng this parameter allows more than
50 values to be entered for a keyword such as the BAND_BIN
keywords which often contain greater than 50 values.  The
format of this ascii file should be one value per line.
KEYINDEX
List of indices into the label keyword indicated in the
parameter, "KEYWORD".  This is used when the keyword has
more than one value, and only specific values need to
be changed rather than all values.  The number of values
entered in this parameter needs to match the number of
values entered in the KEYVALUE parameter.
GRPNAM
Name of the group, if any, that the keyword to be added or
updated is located in. If GRPNAM is left as the default NULL
value, this indicates that the keyword is not located in a
group.  An example of a group name is BAND_BIN.
KEYTYPE
This indicates whether the keyword is of type STRING,
LITERAL, INTEGER, REAL or DOUBLE.  If the default value of
NULL is used LABELS will read the file
$ISISDATA/isis_keywords.sav to find the keyword and keyword
type.  This parameter is used if the keyword is a
non-standard and not located in the above
$ISISDATA/isis_keywords.sav.
DELETE
This contains the name of the keyword that is to be deleted
from the keyword label area.

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