Label | Explanation | Data Type |
Stores | A point layer representing store or facility locations. | Feature Layer |
Store ID Field
| The unique ID field representing a store or facility location. | Field |
Customers | An input point layer representing customers or patrons. | Feature Layer |
Associated Store ID Field
| An ID field that will be used to assign individual customers to stores. | Field |
Output Feature Class
| The output trade area feature class. | Feature Class |
Method
| Specifies the type of customer-derived trade area that will be generated.
| String |
Radii (%)
| The values that will be used to represent the percentage of customers—for example, total count or a customer attribute and total sales assigned to each store. Each value represents one trade area polygon. | Double |
Customer Aggregation Type
| Specifies the type of aggregation that will be used.
| String |
Customer Weight Field
(Optional) | The field that will be used to calculate the trade areas. This is based on either the number of customers (count) or the calculated weighted value assigned to each customer. | Field |
Exclude Outlying Customers
(Optional) | Specifies whether outlying customers will be excluded from the trade area generation.
| Boolean |
Cut-off Distance
(Optional) | The distance beyond which customers will be considered outliers and excluded from consideration during trade area generation. | Linear Unit |
Dissolve Option
(Optional) | Specifies whether polygons of the entire area will be created or the polygons will be split into individual features.
| String |
Use Customers Centroid for Trade Area Center
(Optional) | Specifies whether the centroid of your customer area will be used to calculate trade areas outward from this point.
| Boolean |
Distance Type
(Optional) | The method of travel that will be used to calculate the distance. | String |
Distance Units
(Optional) | The units that will be used for the distance values. | String |
Travel Direction
(Optional) | Specifies the direction of travel that will be used between stores and 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.
| 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. | 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 that can be used to find the optimal threshold limit. | Long |
Minimum Step
(Optional) | The minimum increment distance or time—for example, 1 mile or 1 minute—that will be used between iterations to expand until the threshold is reached. | Double |
Threshold Percent Difference
(Optional) | The maximum percentage difference between the target value and threshold value that will be used when determining the threshold drive time, for example, 5 percent. The default value is 5. | Double |
Available with Business Analyst license.
Summary
Creates trade areas around stores based on the number of customers or volume attribute of each customer.
Illustration
Usage
The spatial reference of the output feature class will be the same as that of the store layer.
The Stores and Customers parameter values must both be point features.
Valid numeric values must be used when identifying a volumetric field to be used as a weighted value.
The trade area boundaries can be set to expand until they encompass user-prescribed customer counts or summed and weighted numeric values, such as sales.
Store-to-customer assignments are controlled during setup using a common, user-specified ID.
Parameters
arcpy.ba.CustomerDerivedTA(in_stores_layer, store_id_field, in_customers_layer, link_field, out_feature_class, method, rings, customer_aggregation_type, {customer_weight_field}, {exclude_outlying_customers}, {cutoff_distance}, {dissolve_option}, {use_customer_centroids}, {distance_type}, {units}, {travel_direction}, {time_of_day}, {time_zone}, {search_tolerance}, {polygon_detail}, {iterations_limit}, {minimum_step}, {target_percent_diff})
Name | Explanation | Data Type |
in_stores_layer | A point layer representing store or facility locations. | Feature Layer |
store_id_field | The unique ID field representing a store or facility location. | Field |
in_customers_layer | An input point layer representing customers or patrons. | Feature Layer |
link_field | An ID field that will be used to assign individual customers to stores. | Field |
out_feature_class | The output trade area feature class. | Feature Class |
method | Specifies the type of customer-derived trade area that will be generated.
| String |
rings [rings,...] | The values that will be used to represent the percentage of customers—for example, total count or a customer attribute and total sales assigned to each store. Each value represents one trade area polygon. | Double |
customer_aggregation_type | Specifies the type of aggregation that will be used.
| String |
customer_weight_field (Optional) | The field that will be used to calculate the trade areas. This is based on either the number of customers (count) or the calculated weighted value assigned to each customer. | Field |
exclude_outlying_customers (Optional) | Specifies whether outlying customers will be excluded from the trade area generation.
| Boolean |
cutoff_distance (Optional) | The distance beyond which customers will be considered outliers and excluded from consideration during trade area generation. | Linear Unit |
dissolve_option (Optional) | Specifies whether polygons of the entire area will be created or the polygons will be split into individual features.
| String |
use_customer_centroids (Optional) | Specifies whether the centroid of your customer area will be used to calculate trade areas outward from this point.
| Boolean |
distance_type (Optional) | The method of travel that will be used to calculate the distance. | String |
units (Optional) | The units that will be used for the distance values. | String |
travel_direction (Optional) | Specifies the direction of travel that will be used between stores and 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.
| 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. | 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 that can be used to find the optimal threshold limit. | Long |
minimum_step (Optional) | The minimum increment distance or time—for example, 1 mile or 1 minute—that will be used between iterations to expand until the threshold is reached. | Double |
target_percent_diff (Optional) | The maximum percentage difference between the target value and threshold value that will be used when determining the threshold drive time, for example, 5 percent. The default value is 5. | Double |
Code sample
The following Python window script demonstrates how to use the CustomerDerivedTA function.
import arcpy
arcpy.ba.CustomerDerivedTA("Facilities", "ID", "Customers", "ID",r"C:\Temp\Output.gdb\TradeArea75pct","DETAILED_WITH_SMOOTHING", [75], "COUNT", None,"ALL_POINTS", None, "OVERLAP", "USE_STORES", '', '',"TOWARD_STORES", None, "TIME_ZONE_AT_LOCATION", None,"STANDARD", 10, None, 5)
Environments
Licensing information
- Basic: Requires Business Analyst
- Standard: Requires Business Analyst
- Advanced: Requires Business Analyst