shiftreg Documentation

shiftreg - Shift image by a line and sample offset
shiftreg shifts an image to subpixel accuracy in exactly the same manner
as coreg2.  It lives to perform coreg2-like shifts on ISIS cubes for
situations that require pre-processing of the input registration files
and the need to apply the actual shifts to original source image cubes.

YOFFSET and XOFFSET correspond to the DYX output array parameter from
the coreg2 application.  YOFFSET = DYX(1) and XOFFSET = DYX(2).  Whole
integer values of these parameters equate to a whole pixel (or nearest
neighbor) shift.

All bands from the input cube file (FROM) are spatially adjusted by
the indicated registration offset.  All suffixes, bottom, side and back
planes, are NOT propagated from the input file to the output just as
in coreg2.

Programmer: Kris Becker, USGS, Flagstaff, Arizona

File name of the cube
that will be registered

NONE

Subcube specified for
FROM file

--

Output file name

NONE

Sample offset

0.0

Line offset

0.0

Truth image to which "from"
cub is registered.

--

Name of text file containing
registration parameters

--

Output pixel type

0

Minimum and maximum
output pixel range

0.0,0.0

ADDITIONAL NOTES:

Parm	Description
FROM	The name of the input cube file. This file will be shifted the indicated offsets. (Default extension is .cub)
SFROM	The input subcube specifier. Allows the user to select a subarea of the input cube for processing. The dimensions of the output cube are a function of this specification. The default selects the entire cube.
TO	The output cube file created by shiftreg. Will be the same pixel type as the input file unless a new pixel type is specified in the OTYPE parameter. (Default extension is Example: output
OTYPE	Output pixel data type. Permitted values are: 0 - 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)
ORANGE	Output pixel data range. If the output pixel type is 1 (8-bit integer with type conversion parameters) or 2 (16-bit integer with type conversion parameters), then the type conversion parameters 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 the special "representation saturation" value. The ORANGE parameter is ignored if the output pixel type is 3 (32-bit floating point) since type conversion parameters are not applicable to floating point pixel values. If both ORANGE(1) and ORANGE(2) are 0.0, then the type conversion parameters in the output file will automatically be set to represent the minimum and maximum values that the output bit type can store. (The user will be required to supply a specific range for ORANGE if the input pixel type is 3 (32-bit floating point) and the output pixel type is 1 (8-bit with type conversion parameters) or 2 (16-bit with type conversion parameters)).
TFROM	Truth image for subpixel registration
REGFILE	This is the name of the file from which the subpixel registration specification will be read. The file has the following columns: FROM_IMGID TRUTH_IMGID LINE_OFFSETS SAMP_OFFSETS R COEF_ARRAY
XOFFSET	Specifies the number of pixels in the SAMPLE dimension to shift the image. A negative value will shift the image to the right; a positive value will shift the image to the left. This can be viewed as an offset from the current output pixel line and sample. When XOFFSET is added to the current output pixel sample location, it gives the new sample coordinate that contributes to the output pixel value.
YOFFSET	Specifies the number of pixels in the LINE dimension to shift the image. A negative value will shift the image down; a positive value will shift the image up. This can be viewed as an offset from the current output pixel line and sample. When YOFFSET is added to the current output pixel line location, it gives the new line coordinate that contributes to the output pixel value.