Mask

Raster Analysis tasks that have the mask property in their context parameter will only consider those cells that fall within the analysis mask in the operation for the output raster.

Mask syntax

1
2
3
{"mask": {
  "url": "https://<servername.domain.com>/arcgis/rest/services/<servicename>/ImageServer"}
}

There is no mask specified by default. The mask can be a raster or a feature dataset. If the analysis mask is a raster, all cells that have a value will be considered to define the mask. Cells in a mask raster that are NoData will be considered to be outside the mask and will be NoData in the output. If the analysis mask is a feature dataset, it will internally be converted to a raster on execution. For this reason, you should ensure that the Cell Size and Snap Raster are set appropriately for your analysis.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close