bandcopy Documentation

bandcopy - Copy core band or backplane of cube into another cube
This program copies a selected core band or backplane of a cube into an
arbitrary core band or backplane of another existing cube.  If writing
to a core band, an existing band in the new cube will be overwritten.
If writing to a backplane, an existing backplane may be overwritten, or
a new backplane added if the cube is band sequential.

The BAND_BIN keywords of the output cube label will NOT be changed to
reflect changes in the core.  BAND_SUFFIX keywords will however reflect
changes to the backplanes, including new backplanes.  Also, when copying
an input backplane to an output backplane, if the backplane contains
a set of Region of Interest (ROI) definitions, then the ROI description
keywords are copied to the output file.

This version of the program will only modify the output cube file.  It
will not copy core bands or backplanes within the input file.

Appropriate conversions will be done between input and output pixels.
Input core bands or backplanes copied to output core bands will be
converted to the output core pixel type.  (The user may supply an
arbitrary multiplier to put the pixels within the range of core
values.)  Input core bands copied to output backplanes will always be
converted to 32-bit floating point pixels.  Input backplanes copied to
output backplanes will preserve their pixel type.  The range of input
values that can be represented by an output BACKPLANE may be specified
with the ORANGE parameter.  (This applies only to copying numerical
planes, not input ROI backplanes.)

The program can process an input cube file that is stored in either
BSQ, BIL or BIP storage order.  The image size of the virtual input
cube must be the same as the image size of the output file.

Programmer: Kris Becker, USGS, Flagstaff, Az

Input cube file name
 (default extension is .cub)

NONE

Input subcube specifier

--

Output cube file name
 (default extension is .cub)

NONE

Source band number

NONE

Source backplane name

--

Destination band number

NONE

Destination backplane name

--

Output pixel multiplier

1.0

Output numerical BACKPLANE
 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. 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 **
TO	Output cube file name. If the file extension is omitted, then ".cub" will be assumed. This must be different from the FROM file.
IBAND	Index of band in core of input cube. Negative index to select input backplane by number, zero index to select backplane by name with the IBCKNAM parameter.
IBCKNAM	Name of selected backplane, when IBAND is 0.
OBAND	Index of destination band in core of output cube. Negative index for destination backplane. Zero index if adding or replacing a backplane named by OBCKNAM.
OBCKNAM	WHEN OBAND = 0: name of destination backplane. If backplane with given name exists, it will be replaced. Otherwise, it will be added to the cube. WHEN OBAND < 0: name to be given to -OBANDth backplane, which is replaced by input band or backplane.
MUL	Specify a multiplier value when moving a 32-bit floating point backplane into an 8-bit or 16-bit integer core band so that the pixels will will fit into the available range.
ORANGE	This parameter is used only when a core plane or a numerical backplane (not an ROI backplane) is being copied to an output backplane. Specifies the output pixel data range. If ORANGE is NULL, then the BAND_SUFFIX_BASE and BAND_SUFFIX_MULTIPLIER in the output file will be set to represent the same range of data as the input file. If output backplane pixel type is 1 (8-bit) or 2 (16-bit), then the BAND_SUFFIX_BASE and BAND_SUFFIX_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 the output backplane pixel data type is 3 (32-bit) since the BAND_SUFFIX_BASE and BAND_SUFFIX_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.