Isis 3 Application Documentation
Set pixels to NULL using a mask cube
Description
This program masks (or NULLs) pixels in an input cube. The input cube is
NULLed using a mask cube. This is done by specifying a minimum/maximum
pixel range in the mask cube. Pixels which fall outside the range in
the mask will be set to NULL in the output cube. Pixels inside the range
will be propagated from the input cube to the output. An option exists to
reverse the masking process so that pixels outside the range are preserved,
and pixels inside the range are NULLed.
Categories
History
| Kris Becker | 1990-12-03 |
Original version
|
| Tracie Sucharski | 2002-06-19 |
Ported to Isis 3.0
|
| Kim Sides | 2003-05-13 |
Added application test
|
| Stuart Sides | 2003-05-16 |
Modified schema location from astogeology... to isis.astrogeology..."
|
| Stuart Sides | 2003-07-29 |
Modified filename parameters to be cube parameters where necessary
|
| Sharmila Prasad | 2009-08-24 |
Set Internal Default for "MASK" to be "FROM"
|
| Steven Lambright | 2010-10-13 |
Removed printf and now respecting cube attributes set on input cube
|
|
Parameter Groups
Files
|
Name
|
Description
|
| FROM |
Input cube to mask
|
| MASK |
Mask cube
|
| TO |
Output cube
|
Mask Options
|
Name
|
Description
|
| MINIMUM | Minimum value of range to mask |
| MAXIMUM | Maximum value of range to mask |
| PRESERVE | Indicates whether to preserve pixels inside or outside of range. |
Special Pixels
|
Name
|
Description
|
| SPIXELS | Special pixels to include as mask |
|
Files:
FROM
Description
Use this parameter to select the filename. All bands within the file
will be masked.
|
Type
| cube |
|
File Mode
| input |
|
Filter
|
*.cub
|
Files:
MASK
Description
Use this parameter to select the filename to be used as the mask.
If this parameter is not explicitly entered, it will default to the
same filename as FROM
|
Type
| cube |
|
File Mode
| input |
|
Internal Default
|
FROM
|
|
Filter
|
*.cub
|
Files:
TO
Description
This file will contain the results of the masked cube
|
Type
| cube |
|
File Mode
| output |
Mask Options:
MINIMUM
Description
This defines the minimum range of valid data in the mask cube.
|
Type
| double |
|
Internal Default
|
ISIS minimum
|
|
Less Than or Equal
| MAXIMUM
|
Mask Options:
MAXIMUM
Description
This defines the maximum range of valid data in the mask cube.
|
Type
| double |
|
Internal Default
|
ISIS maximum
|
|
Greater Than or Equal
| MINIMUM
|
Mask Options:
PRESERVE
Description
This parameter indicates whether the pixels chosen to mask are within the range given
or outside of the range given. If INSIDE, pixels inside of given range will be masked.
If OUTSIDE, pixels outside the range will be masked.
|
Type
| string |
|
Default
|
INSIDE
|
|
Option List:
|
|
Option |
Brief |
Description |
| INSIDE | Mask inside range |
If the mask pixel is inside the given range (indicated with the MINIUMUM
and MAXIMUM parameters), the input pixel will be preserved in the output
cube, otherwise it will be NULLed.
|
| OUTSIDE | Mask outside range |
If the mask pixel is outside the given range (indicated with the MINIMUM
and MAXIMUM parameters), the input pixel we be preserved in the output
file, otherwise it will be NULLed.
|
|
Special Pixels:
SPIXELS
Description
This indicates which special pixel values are to be included as valid
pixels in the mask. For example, a NULL in the mask cube will cause
the output to be NULL if the NULL or ALL option is selected. If NONE
was selected, then the input pixel would be propagated to the output
cube.
|
Type
| string |
|
Default
|
NULL
|
|
Option List:
|
|
Option |
Brief |
Description |
| NONE | None |
No special pixels are considered valid in the mask.
|
| NULL | Null pixels |
Null pixels will be included in the mask.
|
| ALL | All special pixels |
All special pixels included in the mask range
|
|