transpose Documentation

transpose - Transpose standard 3D cube to requested storage order
TRANSPOSE converts any standard cube file stored in any format to a any
other standard storage order.  This function is useful for formatting a
cube into an order that suits a particular need.  All cube label
information is preserved.  TRANSPOSE will propagate any and all suffix
information to the output cube and allows the user to add suffix planes
to the output cube.

Some useful functions include reformatting a cube into Band SeQuenital
(BSQ) storage order so that it is easily viewable by QL3.  QL3 deals
more efficiently with cubes in BSQ storage order.  Another use is for
transposing an Instrument Spectral Library (ISL), which is stored in
Band Interleaved by Pixel (BIP), to BSQ so it may be viewed by QL3 or
processed by other ISIS routines that do not handle the BIP storage
order.

Note that the least efficient processing scenario this program will
handle is when the input file is in BIP format and the requested output
storage order is BSQ.  Processing times for this scenario increase
significantly as the size of the input cube becomes increasingly
larger.  Most all other cases are processed more rapidly.

TRANSPOSE does not provide the ability to convert to other pixel types
since other ISIS functions exist that provide this function.

Programmer:  Jim Mathews, 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

Specifies the desired output
cube storage order
BSQ - Band SeQuential
BIL - Band Interleaved by Line
BIP - Band Interleaved by Pixel

"BSQ"

Suffix planes to add.  In order
sideplanes, bottomplanes, and
backplanes
  (default is 0,0,0)

0,0,0

Comment for user

" "

ADDITIONAL NOTES:

Parm	Description
FROM	The input cube file name that is to be transposed (default extension is .CUB) EX: ISIS$WORK:fromfile.CUB
SFROM	Input subcube specifier. Selects the part of the input cube file that is to be transposed. Note that for ISLs, all the backplane information should always be propagated.
TO	Name of the output transposed cube file. The dimensions of this file are subject to the input subcube specifier applied to the FROM file. EX: ISIS$WORK:tofile.CUB
ORDER	Specifies the desired storage order of the output cube. All standard ISIS storage orders, BSQ, BIL, and BIP, are supported by TRANSPOSE.
XTRSUF	Specifies the number of extra suffix planes to add to the output cube. The numbers represent the number of extra sideplanes, bottomplanes, and backplanes respectively. The default value is 0,0,0.
USERNOTE	Specifies a comment that will be entered into the output log file and history entry in the output file.