Generate Geographies From Overlay (Business Analyst)

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 layer is used to define which features of the standard geography level layer will be included in the Output Feature Class.

• The Output Feature Class 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 value is not available when using online data.

• This tool will consume credits under certain circumstances, for example, if one or more Ratios 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 Input Features and Geography Level inputs.

Syntax

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

Parameter	Explanation	Data Type
geography_level	The geography level that will be used to define the trade area.	String
in_features	The features 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 used to identify the input_features parameter—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 the ratios to be calculated. NO_RATIOS —No ratios will be implemented. This is the default. AREA_ONLY —Only the ratios within the portion (area) of the standard geography level that intersects an input feature will be implemented. ALL_RATIOS —All available ratios will be implemented. This option is not available when using online data.	String

Code sample

GenerateGeographiesFromOverlay example (Python window)

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

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

Environments

Current Workspace, Data Source

Licensing information

• Basic: Requires Business Analyst
• Standard: Requires Business Analyst
• Advanced: Requires Business Analyst