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.
| String |
Ratios
(Optional) | Specifies the ratios that will be calculated.
| String |
Available with Business Analyst license.
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 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.
This tool will consume credits under certain circumstances, for example, if one or more Ratios value variables are selected and are connected to ArcGIS Online, there will be a credit consumption similar to the Enrich Layer tool. Credit consumption also depends on the number of partial intersections between the Input Features and Geography Level inputs.
Parameters
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.
| String |
ratios (Optional) | Specifies the ratios that will be calculated.
| String |
Code sample
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
Licensing information
- Basic: Requires Business Analyst
- Standard: Requires Business Analyst
- Advanced: Requires Business Analyst