Help

AOI Mask

Summary

Generates a masking feature by erasing an area from an input area of interest (AOI) polygon. The masking feature is the difference between the erase and the AOI features. The tool writes an ID value from the AOI polygon and the erase feature class name to a new mask feature in an output feature class. You can use the masking feature to hide parts of layers that render beneath it and outside the erase features. Use this tool to generate aeronautical cartographic data like range rings.

After running the AOI Mask tool you can use the Feature Display Settings tool to configure layer masking in ArcMap.

Usage

  • The tool erases portions of the Input AOI Features to create the output masking feature. There should be only one feature in Input AOI Features. You can restrict Input AOI Features to one feature through a selection set or a feature layer definition query.

  • AOI Feature SQL Query and Erase Features SQL Query will automatically populate if there are selected features or a layer definition query defined in Input AOI Features and Input Erase Features.

  • In ModelBuilder, use the Make Feature Layer tool to create feature layers for Input AOI Features and Input Erase Features. Make Feature Layer allows you to define a layer definition query that will automatically populate the AOI Feature SQL Query and Erase Features SQL Query parameters.

  • Input Erase Features can have one or more polygon features.

  • Input polygons that are coincident with AOI features will be removed from the selection set the tool is processing. If your Input AOI Features and Input Erase Features have identical geometry, Output Features will be empty.

  • Create one output feature class per product.

Syntax

AOIMask_aviation (input_aoi_features, input_aoi_feature_query, input_id_field, input_erase_features, input_erase_features_query, output_features)
ParameterExplanationData Type
input_aoi_features

The polygon area of interest feature. This feature, minus the erase area, will form the output mask feature.

Feature Layer
input_aoi_feature_query

Query that retrieves a single AOI feature. This is automatically populated if layer definition queries exist in ArcMap.

SQL Expression
input_id_field

A field from the Input AOI Features used to identify which AOI was used to create the output feature.

Field
input_erase_features

The features used to erase areas from Input AOI Features.

Feature Layer
input_erase_features_query

Query that retrieves polygon features. This is automatically populated if layer definition queries exist in ArcMap.

SQL Expression
output_features

Feature class where the output mask polygon will be written.

Feature Layer

Code sample

AOIMask example (Python window)

This ArcGIS Python window script demonstrates how to use the AOIMask tool.

# polygon area of interest features
inAoiFeatures = "c:/data/AOIMask.gdb/Airspace"

# query should limit inAoiFeatures to 1 feature
inAoiFeatQuery = "OBJECTID = 770"

# field used to identify input aoi feature
inIdField = "Name_Txt"

# features used to erase inAoiFeatures
inEraseFeatures = "c:/data/AOIMask.gdb/ADHPSurfaceArea"

# query used to restrict inEraseFeatures
inEraseFeaturesQuery = "OBJECTID = 200"

# output feature class
outFeatures = "c:/data/AOIMask.gdb/AOIMask"

# execute AOIMask
arcpy.AOIMask_aviation(inputAoiFeats,inputAoiFeatQuery,inIdField,inEraseFeatures,inEraseFeaturesQuery,outFeatures)

Environments

Licensing information

  • ArcGIS Desktop Basic: No
  • ArcGIS Desktop Standard: No
  • ArcGIS Desktop Advanced: Requires Aviation Charting

Related topics