AOI Mask (Aeronautical)
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.
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 Model Builder, 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 (for example, Terminals_M).
This tool always runs in foreground mode. If you run this tool with Background Processing checked on, the tool will automatically switch to foreground processing.
Syntax
| Parameter | Explanation | Data 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 Class |
Code Sample
This ArcGIS Python window script demonstrates a use of the AOIMask function.
import arcpy
# Load Toolbox
arcpy.ImportToolbox(r'C:\Program Files\ArcGIS\Desktop10.0\ArcToolbox\Toolboxes\Aeronautical Tools.tbx')
# Process: AOI Mask
arcpy.AOIMask_Aeronautical("Database Servers\127.0.0.1_SQLEXPRESS.gds\ASPm(VERSION:dbo.DEFAULT)\ASPm.DBO.Airspace",
"Name_Txt = 'AWP NV E5 MINDEN'", "Name_Txt",
"Database Servers\127.0.0.1_SQLEXPRESS.gds\ASPm (VERSION:dbo.DEFAULT)\ASPm.DBO.ADHPSurfaceArea",
"OBJECTID = '12366' OR OBJECTID = '12367'",
"Database Servers\127.0.0.1_SQLEXPRESS.gds\ASPm (VERSION:dbo.DEFAULT)\ASPm.DBO.AOIMask")