Generate Drive Time Trade Areas (Business Analyst)

Available with Business Analyst license.

Summary

Creates a feature class of trade areas around point features based on travel time and distance.

Illustration

Generate Drive Time Trade Areas tool illustration

Usage

  • You must be signed in to ArcGIS Online or have Business Analyst Data installed.

  • You can create drive time rings that are nonoverlapping using various travel modes.

  • The Time of Day parameter is used to model output polygons based on historical traffic data at the specified day and time.

  • The ID Field parameter is used to create an attribute in the output that uniquely identifies each polygon and respective input point.

Syntax

arcpy.ba.GenerateDriveTimeTradeArea(in_features, out_feature_class, distance_type, distances, {units}, {id_field}, {dissolve_option}, {remove_overlap}, {travel_direction}, {time_of_day}, {time_zone}, {search_tolerance}, {polygon_detail}, {input_method}, {expression})
ParameterExplanationData Type
in_features

The input point feature layer.

Feature Layer
out_feature_class

The output feature class containing the drive time polygons.

Feature Class
distance_type

Defines how the drive time is calculated based on method of travel.

String
distances
[distances,...]

The distances that will be used for drive time calculations.

Double
units
(Optional)

The units that will be used for the distance values. The default value is miles.

String
id_field
(Optional)

A unique ID field for existing facilities.

Field
dissolve_option
(Optional)

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

  • OVERLAP Each polygon will include the area reachable from the facility up to the distance value. This is the default.
  • SPLIT Each polygon will include only the area between consecutive distance values.
String
remove_overlap
(Optional)

Specifies whether overlapping concentric rings will be created or overlap will be removed from multiple locations in relation to one another.

  • REMOVE_OVERLAPPolygons will be split and the overlap between output features will be removed.
  • KEEP_OVERLAPOutput features will be created with overlap. This is the default.
Boolean
travel_direction
(Optional)

Specifies the direction of travel that will be used between stores and customers.

  • TOWARD_STORESThe direction of travel will be from customers to stores. This is the default.
  • AWAY_FROM_STORESThe direction of travel will be from stores to customers.
String
time_of_day
(Optional)

The time and date that will be used when calculating distance.

Date
time_zone
(Optional)

Specifies the time zone that will be used for the Time of Day parameter.

  • TIME_ZONE_AT_LOCATIONThe time zone in which the territories are located will be used. This is the default.
  • UTCCoordinated universal time (UTC) will be used.
String
search_tolerance
(Optional)

The maximum distance that input points can be from the network. Points located beyond the search tolerance will be excluded from processing.

The parameter requires a distance value and units for the tolerance. The default value is 5000 meters.

Linear Unit
polygon_detail
(Optional)

Specifies the level of detail that will be used for the output drive time polygons.

  • STANDARD Polygons with a standard level of detail will be created. This is the default.
  • GENERALIZEDGeneralized polygons will be created using the hierarchy present in the network data source to produce results quickly.
  • HIGH Polygons with a high level of detail will be created for applications in which very precise results are important.
String
input_method
(Optional)

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

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

A fields-based expression used to calculate drive time.

SQL Expression

Code sample

GenerateDriveTimeTradeArea example (Python window)

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

import arcpy
arcpy.ba.GenerateDriveTimeTradeArea(r"C:\Project1.gdb\DriveTime.gdb\Starbucks","\Documents\ArcGIS\Projects\Project1.gdb\Starbucks_GenerateDriveTimeTradeArea","Driving
Distance", 1.3, "MILES", None,"OVERLAP", "KEEP_OVERLAP",
"TOWARD_STORES",None, "TIME_ZONE_AT_LOCATION", None,"STANDARD", Values,
None)

Licensing information

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

Related topics