Available with Business Analyst license.
Summary
Creates a feature class of ring trade areas that expand around point features until the threshold value is reached.
Usage
The size of the output rings is determined by Threshold Values entered for a selected Threshold Variable from the active Business Analyst dataset.
Multiple threshold rings can be created around each input by typing individual values into separate threshold value text boxes.
The ID Field parameter value uniquely identifies the point location around which threshold rings are created.
Syntax
arcpy.ba.GenerateThresholdRingTradeArea(in_features, out_feature_class, threshold_variable, threshold_values, {units}, {id_field}, {input_method}, {expression})| Parameter | Explanation | Data Type |
in_features | The input point feature layer. | Feature Layer |
out_feature_class | The output feature class. | Feature Class |
threshold_variable | The selected Business Analyst dataset variable to which the threshold value will be applied. | String |
threshold_values [threshold_values,...] | The size of the output rings. The rings will expand until they contain the threshold value of the selected variable. | Double |
units (Optional) | The distance units to be used with the threshold values. | String |
id_field (Optional) | An ID that uniquely identifies each input point and is included in the output as an attribute. | Field |
input_method (Optional) | Specifies the type of value that is to be used for each drive time.
| String |
expression (Optional) | A fields-based expression to calculate the radii. | SQL Expression |
Code sample
The following Python window script demonstrates how to use the GenerateThresholdRingTradeArea tool.
import arcpy
arcpy.ba.GenerateThresholdRingTradeArea("SF_Custs",r"C:\Project1.gdb\SF_Custs_GenerateThresholdRingTradeArea","populationtotals.totpop_cy",[50000,
100000], "MILES", "STORE_ID", Values, None)Environments
Licensing information
- Basic: Requires Business Analyst
- Standard: Requires Business Analyst
- Advanced: Requires Business Analyst