Mask function

Overview

Using the Mask function, specify one or more NoData values, or a range of valid pixel values, to be removed from an output raster.

Notes

The table below offers an example using NoData Interpretation.

Example of pixel value inputs and output

Band 1Band 2Band 3NoData InterpretationRGB

NoData

1

1

All

1

NoData

NoData

NoData

All

NoData

NoData

1

1

Any

NoData

NoData

NoData

NoData

Any

NoData

Parameters

Parameter nameDescription

Raster

The input raster.

NoData Interpretation

This refers to how NoData Values will impact the output image.

You can select from the following two options:

  • Match Any—If the NoData value you specify occurs for a pixel in a specified band, that pixel in the output image will be NoData. This is the default.
  • Match All—The NoData values you specify for each band must occur in the same pixel for the output image to contain the NoData pixel.
NoData Values

The NoData values can be specified for each band. You can specify more than one value by entering a space-delimited list.

Included Ranges

The included ranges can be specified for each band by specifying a minimum and maximum value; any values outside the range will be returned as NoData. A pixel is included if the pixel's value falls within any of the ranges specified. Therefore, if band 1 has a range of 5–10 and band 2 has a range of 15–20, and the pixel value for band 1 is 8, this pixel will not be masked.

Related topics


In this topic
  1. Overview
  2. Notes
  3. Parameters