poly Documentation

poly - Polynomial algebra on an input cube

The "poly" program will perform polynomial algebra on an input cube to
the ORDER the user specifies.

The algorithm for POLY follows:

NP = ADD + (DN * MUL1) + (DN**2 * MUL2) + ... + (DN**8 + MUL8) where,

   NP = new pixel value
   ADD = user defined constant
   DN = pixel value from the input cube
   MUL1 ... MUL8 = user defined multiplication factors

The user should enter a multiplication factor (MUL1, MUL2, etc.) and a
constant factor (ADD) for each band of the input cube that will be
used to create the output cube (ie. each band selected using the SFROM
parameter).  The MUL1, MUL2, etc. and ADD factors can be entered in
two ways.  The first is to simply specify the factors as the values of
the TAE ADD or MUL1, MUL2, etc. parameters.  The second is to enter the
factors using a binary table file (TBLMUL).  TBLMUL has a column for
ADD, MUL1, MUL2, etc. up to MULx, where x is the number entered in the
ORDER parameter.  These column names are required as is the table
object name of "TABLE".  Each column contains real numbers and can be
created using a text editor to create the ASCII file and the "asc2tbl"
ISIS program to convert the file to binary form.  If more than 50 MUL1,
MUL2, etc. and ADD factors are being entered, the user must use the
binary table file option.  If you wish to use the same MUL1, MUL2,
etc. or ADD factor for all bands in the FROM cube, enter a single MUL1,
MUL2, etc. or ADD factor for the TAE parameter value.

The maximum ORDER for the polynomial is 8.

If a special pixel value is encountered in the input cube, the
special pixel value will be propogated to the output file.  All suffix
planes are propogated to the output file unchanged.

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

Polynomial order. Max is 8

1

Table file of multiplication
factors and additive values

--

Constants to add to product.

0.0

Constants for term DN * MUL1
  (ORDER = 1 or greater)

1.0

Constants for term DN**2 * MUL2
  (ORDER = 2 or greater)

1.0

Constants for term DN**3 * MUL3
  (ORDER = 3 or greater)

1.0

Constants for term DN**4 * MUL4
  (ORDER = 4 or greater)

1.0

Constants for term DN**5 * MUL5
  (ORDER = 5 or greater)

1.0

Constants for term DN**6 * MUL6
  (ORDER = 6 or greater)

1.0

Constants for term DN**7 * MUL7
  (ORDER = 7 or greater)

1.0

Constants for term DN**8 * MUL8
  (ORDER = 8)

1.0

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

--

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. 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 **
ORDER	The polynomial order to use in calculating the new DN values
TBLMUL	A binary table file of multipication factors and ADD values. The table contains columns called ADD, MUL1, MUL2, ... MUL8, which are real numbers. There should be a MUL1, MUL2, etc. column up to the number entered in the ORDER parameter. One multiplication factor and one ADD value should be used for each band selected in the subcube specifier. The table object name for TBLMUL is "TABLE".
ADD	Constant value for each band selected in the subcube specifier. These values will be used for a polynomial of any ORDER. A maximum of 50 values can be entered. If only one value is entered, it will be used for all the bands. Use this parameter only if TBLMUL is set to the NULL value.
MUL1	Multiplication value for each band selected in the subcube specifier. These values will be used for a polynomial of ORDER = 1 or greater. A maximum of 50 values can be entered. If only one value is entered, it will be used for all the bands. Use this parameter only if TBLMUL is set to the NULL value.
MUL2	Multiplication value for each band selected in the subcube specifier. These values will be used for a polynomial of ORDER = 2 or greater. A maximum of 50 values can be entered. If only one value is entered, it will be used for all the bands. Use this parameter only if TBLMUL is set to the NULL value.
MUL3	Multiplication value for each band selected in the subcube specifier. These values will be used for a polynomial of ORDER = 3 or greater. A maximum of 50 values can be entered. If only one value is entered, it will be used for all the bands. Use this parameter only if TBLMUL is set to the NULL value.
MUL4	Multiplication value for each band selected in the subcube specifier. These values will be used for a polynomial of ORDER = 4 or greater. A maximum of 50 values can be entered. If only one value is entered, it will be used for all the bands. Use this parameter only if TBLMUL is set to the NULL value.
MUL5	Multiplication value for each band selected in the subcube specifier. These values will be used for a polynomial of ORDER = 5 or greater. A maximum of 50 values can be entered. If only one value is entered, it will be used for all the bands. Use this parameter only if TBLMUL is set to the NULL value.
MUL6	Multiplication value for each band selected in the subcube specifier. These values will be used for a polynomial of ORDER = 6 or greater. A maximum of 50 values can be entered. If only one value is entered, it will be used for all the bands. Use this parameter only if TBLMUL is set to the NULL value.
MUL7	Multiplication value for each band selected in the subcube specifier. These values will be used for a polynomial of ORDER = 7 or greater. A maximum of 50 values can be entered. If only one value is entered, it will be used for all the bands. Use this parameter only if TBLMUL is set to the NULL value.
MUL8	Multiplication value for each band selected in the subcube specifier. These values will be used for a polynomial of ORDER = 8. A maximum of 50 values can be entered. If only one value is entered, it will be used for all the bands. Use this parameter only if TBLMUL is set to the NULL value.
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.