Available with Business Analyst license.
Summary
Creates a feature class of network distance trade areas that expand around point features until criteria is reached.
Usage
The size of output polygons is determined by the Threshold Values parameter value provided for a selected Threshold Variable parameter value from the Business Analyst dataset.
Multiple threshold drive time polygons can be created around each input by typing individual values into separate threshold value text boxes.
The ID Field parameter uniquely identifies the point location around which threshold drive time polygons are created.
Syntax
arcpy.ba.GenerateThresholdDriveTimeTradeArea(in_features, out_feature_class, threshold_variable, threshold_values, distance_type, {units}, {id_field}, {travel_direction}, {time_of_day}, {time_zone}, {search_tolerance}, {polygon_detail}, {iterations_limit}, {minimum_step}, {target_percent_diff}, {input_method}, {expression})| Parameter | Explanation | Data Type |
in_features | The input point feature layer. | Feature Layer |
out_feature_class | The output feature class containing the drive time polygons. | Feature Class |
threshold_variable | The selected Business Analyst dataset variable to which the threshold value will be applied. | String |
threshold_values [threshold_values,...] | The threshold variable value that determines the size of the output rings. The rings will expand until they contain the threshold value of the selected variable. | Double |
distance_type | The method of travel used to create the output polygons. | String |
units (Optional) | The distance units to be used with the threshold values. | String |
id_field (Optional) | The ID that uniquely identifies each input point and is included in the output as an attribute. | Field |
travel_direction (Optional) | Specifies the direction of travel for output polygon creation.
| 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.
| String |
search_tolerance (Optional) | The maximum distance that input points can be from the network. 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.
| String |
iterations_limit (Optional) | Restricts the number of drive times used to find the optimal threshold limit. | Long |
minimum_step (Optional) | The minimum increment distance or time—for example, 1 mile or 1 minute—used between iterations to expand until the threshold is reached. | Double |
target_percent_diff (Optional) | The maximum difference between the target value and threshold value when determining the threshold drive time, for example, 5 percent. The default value is 5. | Double |
input_method (Optional) | Specifies the type of value that will be used for each drive time.
| String |
expression (Optional) | A fields-based expression to calculate drive time. | SQL Expression |
Code sample
The following Python window script demonstrates how to use the GenerateThresholdDriveTimeTradeArea function.
import arcpy
arcpy.ba.GenerateThresholdDriveTimeTradeArea("SF_Custs",r"C:\ Project1\Project1.gdb\SF_Custs_GenerateThresholdDriveTimeTradeArea","populationtotals.totpop_cy",[25000, 50000], "Driving Time","MINUTES", "CUST_ID", None,"TOWARD_STORES", None,"TIME_ZONE_AT_LOCATION", None,"STANDARD", 10, None, 5, Values, None)Environments
Licensing information
- Basic: Requires Business Analyst
- Standard: Requires Business Analyst
- Advanced: Requires Business Analyst