cubespec Documentation

cubespec - Calculate average spectrum from disk cube file
"cubespec" calculates the average spectrum for all or part of an input
cube file.  The average data are written out to a standard ISIS binary
TABLE file.  In addition to the average data, this file will contain
the wavelength, minimum, maximum, standard deviation and number of
valid data values used in computing the average.  An input pixel value
is considered valid if it is neither NULL nor saturated.  Only valid
input values are used in computing the average, standard deviation and
min/max values.  If there are no valid values within the group of
pixels being averaged, then the standard deviation is written to the
file as 0.0 and the average value and min/max values are written to
the file as ISIS NULL pixel values.

The name of the TABLE object in the output file is 'TABLE'.  The value
of the OBJECT_DATA_TYPE keyword is 'SPECTRUM'.  The following are the
column names, data types, default text formats, and descriptions for
the columns in the output table data object:
    BAND (INTEGER*4, I5) - Band number (FILE band number - NOT Virtual
        band number or BAND_BIN_ORIGINAL_BAND)
    WAVELN (REAL*4, F10.4) - Nominal wavelength (micrometers)
    AVERAGE (REAL*4, F12.4) - Average value within the box
    MIN (REAL*4, F12.4) - Minimum value within the box
    MAX (REAL*4, F12.4) - Maximum value within the box
    SIGMA (REAL*4, F12.4) - Standard deviation
    N (INTEGER*4, I9) - Number of valid data values within the box

The format of the output TABLE object is the same as that produced by
the average spectrum functions in the CV display program.

The entire HISTORY of the input cube file will be propagated to the
output TABLE file.

The "ratiocs" program can be used to divide each spectrum in an image
cube by the average spectrum computed by "cubespec".  The "addspec"
program can be used to add (or subtract) an average spectrum to
each spectrum in an image cube.

Programmer: Jim Torson - U.S.G.S. Flagstaff, Arizona

Input cube file name
  (default extension is .cub)

NONE

Input subcube specifier

--

Output average spectrum file
  (default extension is .tbl)

NONE

User comment

" "

ADDITIONAL NOTES:

Parm	Description
FROM	Input cube file name. If the file extension is omitted, then ".cub" will be assumed.
SFROM	This parameter selects the part of the input cube file that will be used for the average spectrum calculation. SFROM specifies the subcube using a single string for all three dimensions of the cube. The order of the three dimensions is always "samples:lines:bands". If a dimension is left blank, all the data for that dimension is selected. The default value of NULL for SFROM selects the entire cube. Any application below can be used for any dimension. To select specific data from any dimension: "10-100(3):11,12,15-20:1-10(2)" = This example will select every third sample starting with sample 10 thru 100. It selects lines 11 and 12, and 15-20. It selects every other band, starting with band 1 thru 10. There are special characters that can be used for selecting a subcube efficiently, such as "*","#", and "~". For examples type "help sfrom" in TAE. **NOTE** For more examples and explanation of the many features of the SFROM parameter, tutor the sfrom.pdf or refer to Introduction To ISIS, Section 6, of the ISIS User's Manual **
TBLTO	Specifies the name of the output ISIS binary TABLE file that will be written to contain the average spectrum data. If the file extension is omitted, then ".tbl" will be assumed.
USERNOTE	Comment from the user. This will be recorded in the ISIS session log file and also in the History entry that is put into the History object of the output file.