circle Documentation

circle - NULL area outside a given circle
This program will set any data outside the given circle to a NULL value.
The user may provide a radius of a circle (in pixels) within a specified
cube or subcube, or the program wil provide a default value equal to the
minimum of no. of lines/2 (nl/2) and no. of samples/2 (ns/2).  The user
may also provide the center line and sample of the circle, or the
program will default to nl/2 and ns/2 respectively.

PROGRAMMER: Kay Edwards, USGS, Flagstaff, Az

Input cube file name
  (default extension is .cub)

NONE

Input subcube specifier

--

Output cube name
  (default extension is .cub)

NONE

Radius of circle in pixels
Default=min of ns/2 and nl/2

--

Center sample of circle
Default= ns/2

--

Center line of circle
Default=nl/2

--

Output pixel type

--

Minimum and maximum
output pixel range

--

Comment to user

--

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.
RADIUS	If a subarea is selected, the default RADIUS will be computed on the size of the subarea.
SAMP	If a subarea is selected, the default SAMP will be half the number of samples of the subarea.
LINE	If a subarea is selected, the default LINE will be half the number of lines of the subarea.
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.