Generate Geographies From Overlay (Business Analyst Tools)

Summary

Generates trade areas from the features of an input standard geography level that has a specified spatial relationship with the input.

Usage

The tool finds the component geography of the given input layer and, for each component geography, calculates how much of its area, population, number of households, and so on, intersect the input feature.
The Input Features parameter value is used to define which features of the standard geography level layer will be included in the output.
The Input Features parameter value can be a point or polygon feature type.
The Ratios parameter cannot be used when the Input Features parameter is a point feature type.
The layer output is based on a polygon-to-polygon selection and is computed by a geometric relationship of the features in both polygon-based layers.
The All ratios option for the Ratio parameter is not available when using online data.

Label	Explanation	Data type
Geography Level	The geography level that will be used to define the trade area.	String
Input Features	The features that will be used to extract the standard geography level features by the specified spatial relationship. It can be either all features from the layer or only those selected once a selection is available.	Feature Layer
ID Field	The field that will be used to identify the Input Features parameter value—for example, the IDs of drive time polygons.	Field
Output Feature Class	The output feature containing the trade area.	Feature Class
Relationship (Optional)	Specifies how the subgeography will be selected from the boundary layer. Intersect—If any of the subgeography features touch or intersect the boundary layer, they will be included in the output layer. This is the default. Have their center in—If the centroids of any of the subgeography features are contained within the boundary layer, they will be included in the output layer. Completely within—Only the features of the subgeography layer that are completely contained within the boundary layer will be included in the output layer.	String
Ratios (Optional)	Specifies how percentages will be calculated. The percentages are generated based on how much each geography intersects the boundary layer and appends the values to the geography layer. No ratios—No percentages will be calculated. This is the default. Area only—The percentage will only be calculated for areas of the geographies that intersect the boundary layer. All ratios—The values calculated will contain percentages for Population, Housing Units, Households, and Business Points.	String

arcpy.ba.GenerateGeographiesFromOverlay(geography_level, in_features, id_field, out_feature_class, {overlap_type}, {ratios})

Name	Explanation	Data type
geography_level	The geography level that will be used to define the trade area.	String
in_features	The features that will be used to extract the standard geography level features by the specified spatial relationship. It can be either all features from the layer or only those selected once a selection is available.	Feature Layer
id_field	The field that will be used to identify the `in_features` parameter value—for example, the IDs of drive time polygons.	Field
out_feature_class	The output feature containing the trade area.	Feature Class
overlap_type (Optional)	Specifies how the subgeography will be selected from the boundary layer. `INTERSECT`—If any of the subgeography features touch or intersect the boundary layer, they will be included in the output layer. This is the default. `CENTROID_WITHIN`—If the centroids of any of the subgeography features are contained within the boundary layer, they will be included in the output layer. `COMPLETELY_WITHIN`—Only the features of the subgeography layer that are completely contained within the boundary layer will be included in the output layer.	String
ratios (Optional)	Specifies how percentages will be calculated. The percentages are generated based on how much each geography intersects the boundary layer and appends the values to the geography layer. `NO_RATIOS`—No percentages will be calculated. This is the default. `AREA_ONLY`—The percentage will only be calculated for areas of the geographies that intersect the boundary layer. `ALL_RATIOS`—The values calculated will contain percentages for Population, Housing Units, Households, and Business Points.	String

Code sample

GenerateGeographiesFromOverlay example (Python window)

The following Python window script demonstrates how to use the GenerateGeographiesFromOverlay function.

import arcpy
arcpy.ba.GenerateGeographiesFromOverlay("US.ZIP5", "TradeArea", "ID",
                                        r"C:\Temp\Output.gdb\OverlayTradeAreas")

Environments

Current Workspace, Data Source, Geographic Transformations

Licensing information