mask
Set pixels to NULL using a mask cube
Requirements
- The input cube must be a level 1 or level 2 ISIS cube or mosaic (single or multiband)
- If the MASK option is used, you will need an input cube, either a single band cube or specify one band of a multiband cube (see Example 1), containing the mask.
There are four ways to use the mask program; and, with all four options, listed below, you will use the PRESERVE parameter. As the name implies, you will "preserve" pixels either inside (which is the program default) or outside a given range. Preserve=inside: means the program will preserve pixels inside the provided range, and pixels that are not inside the range are nulled. Preserve=outside: means the program will preserve pixels outside the provided range, and pixels that are not outside the range are nulled.
Three Ways to Mask:
- The input cube can be masked without specifying a mask cube file by using the minimum and maximum parameters. Pixels outside the specified range are set to NULL. If preserve=outside is specified, the pixels outside the range are preserved.
- You can input a mask cube file. All the corresponding pixels in the input cube are retained for all valid pixels in the mask cube file. If the minimum and maximum values are entered also, then the pixels in the masked cube are checked to determine whether the pixel in the input file should be retained.
- You can input a mask cube file in addition to using the minimum and maximum parameters.
Note that due to the way masking works, an output file will be created regardless of whether or not the mask was applied to the corresponding input. To determine the degree to which an input cube was masked, look for the "PixelsMasked" group in print.prt . If no pixels were masked, there will be a comment present which reads "No pixels were masked in this image".
Categories
Related Objects and Documents
Applications
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 |
Kimberly Oyama | 2014-03-03 | Made default MASK parameter work when FROM cube has multiple bands. Updated Documentation. Added examples. Fixes #1871. |
Andrew Stebenne | 2015-03-22 | Specify that an output cube will be created whether or not the mask was applied. Add an output group to print.prt to indicate how many pixels were masked in the output image. Implements recommendation #898. |
Parameters
Files
Type | cube |
---|---|
File Mode | input |
Filter | *.cub |
Type | cube |
---|---|
File Mode | input |
Internal Default | NULL |
Filter | *.cub |
Type | cube |
---|---|
File Mode | output |
Mask Options
Type | double |
---|---|
Internal Default | ISIS minimum |
Less Than or Equal | MAXIMUM |
Type | double |
---|---|
Internal Default | ISIS maximum |
Greater Than or Equal | MINIMUM |
Type | string | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Default | INSIDE | |||||||||
Option List: |
|
Special Pixels
Type | string | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Default | NULL | ||||||||||||
Option List: |
|
Example 1
An example of using a single band from the input cube as a mask.
Command Line
mask
mask from=I06107001RDR.cub to=I06107001RDR_MaskByBand9.cub mask=I06107001RDR.cub+9
GUI Screenshot
Input Image
Output Image
Example 2
An example of not specifying a mask.
Command Line
mask
mask from=I06107001RDR.cub to=I06107001RDR_MaskByDN.cub minimum=-0.000143
maximum=-0.000116 preserve=outside