USGS

Isis 2 Documentation


bandstats Documentation

bandstats - Compute statistics for individual bands
"bandstats" computes statistics for individual bands as well as
summarizing this information for the entire cube.  The ISIS application
"avg_sd" generates very similar information but for the entire cube.
"bandstats" differs in that there is extra information provided and
each band is isolated.  For instance, the number of special pixels are
further broken down into a count for each of the five special pixel
values: NULL, LOW_INSTR_SAT, LOW_REPR_SAT, HIGH_REPR_SAT and
HIGH_INSTR_SAT.  The minimum and maximum for each band is determined
and the band where the minimum and maximum occured is reported in the
complete file summary.  The sum of each band and standard deviation
are also reported.

Note that the result of each band will be written to the ISIS session
log file, typically a file called "print.prt" or the file referred
to by the value of the environment variable ISIS_LOG_FILE.  The final
complete cube statistics will be reported to both the log file and the
screen.

The user may also specify a data range using the MIN and MAX input
parameters to target specific data.  A count of values that fall
outside this range is also reported.  A special case where data is
outside the valid range and is not a special pixel are isolated and
reported (but only if they occur).  These should be viewed as "freaks
of nature" and could indicate a problem with the data.  These are
reported as INVALID or UNKNOWN.

PROGRAMMER: Kris Becker, U.S.G.S., Flagstaff, AZ

ParmDescriptionDefault
FROM
Input cube file name
  (default extension is .cub)
NONE
SFROM
Input subcube specifier
--
MIN
Valid data minimum value
--
MAX
Valid data maximum value
--
LIST
List mode can be either
a FULL or BRIEF listing
"BRIEF"
USERNOTE
User comment
" "

ADDITIONAL NOTES:

ParmDescription
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.

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 **
MIN
The MIN parameter is supplied to further limit the input
data range that is considered valid for processing.  A
value that is less than MIN is ignored as if it were a
special pixel value.  If this parameter is the TAE NULL
parameter value, then the minimium valid value for the
pixel type is used.
MAX
The MAX parameter is supplied to further limit the input
data range that is considered valid for processing.  A
value that is greater than MAX is ignored as if it were
a special pixel value.  If this parameter is the TAE NULL
parameter value, then the maximum valid value for the
pixel type is used.
LIST
This allows the user to specify the listing mode of for
each band.  For LIST="BRIEF", the band number, pixel
count, sum, average and standard deviation are listed.
For LIST="FULL", additional fields of original band,
wavelength (in micrometers), data minimum and maximum,
number pixels less than MIN, number pixels less than
MAX, number of NULL, LOW_INSTR_SAT, LOW_REPR_SAT,
HIGH_REPR_SAT and HIGH_INSTR_SAT pixels counts and the
number of invalid or unknown pixels are also printed.
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.

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