cubeavg Documentation

cubeavg - Creates a spectral average cube
CUBEAVG creates a spectral average cube.  In other words, a single-band
cube from the average of all bands from the input cube.  There is an
option, MAXSTD, to calculate the average after throwing away outlying
pixels.

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

Input cube file name
  (Default extension is .cub)

NONE

Input subcube specifier

--

Output cube file name
  (Default extension is .cub)

NONE

Output cube containing sums

--

Maximum standard deviation

--

Output pixel type
 NULL = input type
    1 = 8 bit
    2 = 16 bit
    3 = 32 bit

3

Output min/max data range

--

User comment

" "

ADDITIONAL NOTES:

Parm	Description
FROM	Input cube file name. If the file extension is omitted, then ".cub" will be assumed.
SFROM	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. For example, "10-100(3):11,12,15-20:1-10(2)" will select every third sample starting with sample 10 thru 100; lines 11 and 12, and 15-20; and 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 **
TO	Output cube file name. If the file extension is omitted, then ".cub" will be assumed.
SUM	If a filename is given, this will contain the sums of the input.
MAXSTD	By default this option is not used. If a value is entered, it will be used to exclude pixels when calculating the spectral average. It does this in the following manner. The average and standard deviation of the spectrum are calculated. Then, pixel values which deviate more than MAXSTD multiplied by the standard deviation away from the average are excluded. (ie., pixel value > average standard deviation * MAXSTD pixel value < average - standard deviation * MAXSTD) The new average is then calculated using only the included values. Note, in a normal distribution, the following is true: 1 standard deviation = 72% of the data will be included 2 standard deviaitons = 96% of the data will be included 3 standard deviations = 98% of the data will be included
OTYPE	Output pixel data type. Permitted values are: NULL = output type is same as input file pixel type 1 = 8-bit (integer with type conversion parameters) 2 = 16-bit (integer with type conversion parameters) 3 = 32-bit (floating point) When processed data are being written back into the input file, the output pixel type must be the same as the existing pixel type in the input file.
ORANGE	Output pixel data range. If ORANGE is NULL, then the CORE_BASE and CORE_MULTIPLIER in the output file will be set to represent the same range of data as the input file. If OTYPE=1 (8-bit) or OTYPE=2 (16-bit), then the CORE_BASE and CORE_MULTIPLIER in the output file will be set to values that allow representing the specified range of output values. Output values outside this range will be stored as a special "representation saturation" value. The ORANGE parameter is ignored if OTYPE=3 (32-bit) since the CORE_BASE and CORE_MULTIPLIER are not applicable to floating point pixel values. **NOTE** For a more detailed explanation of ORANGE, tutor the orange.pdf.
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.