Generate Trade Area Rings (Business Analyst)

Available with Business Analyst license.

Summary

Creates rings around point locations.

Illustration

Generate Trade Area Rings

Usage

  • Valid numeric distances must be used when defining distance values. Negative distances cannot be used for rings.

  • The Remove Overlap parameter uses Thiessen polygons to remove overlap between output ring polygons.

Syntax

arcpy.ba.GenerateTradeAreaRings(in_features, out_feature_class, {radii}, {units}, {id_field}, {remove_overlap}, {dissolve_option}, {input_method}, {expression})
ParameterExplanationData Type
in_features

The input features containing the center points for the rings.

Feature Layer
out_feature_class

The feature class that will contain the output ring features.

Feature Class
radii
[radii,...]
(Optional)

The distances, in ascending size, used to create rings around the input features.

Double
units
(Optional)

The linear unit to be used with the distance values.

String
id_field
(Optional)

A unique ID field in the ring center layer.

Field
remove_overlap
(Optional)

Creates overlapping concentric rings or removes overlap.

  • REMOVE_OVERLAPThiessen polygons are used to remove overlap between output ring polygons.
  • KEEP_OVERLAPOutput ring features are created with overlap. This is the default.
Boolean
dissolve_option
(Optional)

Specifies whether overlapping or nonoverlapping service areas for a single location will be used when multiple distances are specified.

  • OVERLAPEach polygon will include the area reachable from the facility up to the distance value. This is the default.
  • SPLITEach polygon will include only the area between consecutive distance values.
String
input_method
(Optional)

Specifies the type of value that is to be used for each drive time.

  • VALUESUses a constant value (all trade areas will be the same size). This is the default.
  • EXPRESSIONThe values from a field or an expression (trade areas can be a different size).
String
expression
(Optional)

A fields-based expression to calculate the radii.

SQL Expression

Code sample

GenerateTradeAreaRings example (Python window)

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

import arcpy
arcpy.ba.GenerateTradeAreaRings("sales_locations.shp",r"sales_locations_GenerateTrad.shp", [1, 3, 5],"MILES", "ID", "KEEP_OVERLAP", Values, None)

Environments

Licensing information

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

Related topics