Label | Explanation | Data Type |
Store Layer
| The input point layer representing store or facility locations. | Feature Layer |
Customer Layer
| The input point layer representing customers or patrons. | Feature Layer |
Output Feature Class
| The resultant feature class that will be added to the Contents pane. | Feature Class |
Store ID Field
| A unique ID field representing a store or facility location. | Field |
Associated Store ID Field
| An ID field used to assign individual customers to stores. | Field |
Distance Type
(Optional) | The method of travel that will be used for distance calculation. Straight Line is the default value. When using Portal for ArcGIS or local data sources, travel mode options are dynamically populated. | String |
Measure Units
(Optional) | The type of distance- or time-measuring units that will be used when calculating minimal distance. | String |
Cutoff
(Optional) | The distance beyond which customers will be considered outliers and excluded from consideration during desire line generation. | Double |
Travel Direction
(Optional) | Specifies the direction of travel that will be used between stores and demand points.
| String |
Time of Day
(Optional) | The time at which travel begins. | Date |
Time Zone
(Optional) | Specifies the time zone that will be used for the Time of Day parameter.
| String |
Available with Business Analyst license.
Summary
Generates a series of lines from each customer to an associated store location. These lines are often called spider diagrams.
Note:
This tool is similar to the Generate Origin-Destination Links tool in the Analysis toolbox Proximity toolset.
Illustration
Usage
The store layer and customer layer must be a point feature class.
Generating desire lines with drive time and drive distance will take longer than using the straight-line (Euclidean) distance method.
The output shows the spatial distribution between the Store Layer and the Customer Layer parameter values and calculates the distance values between each store and customer.
Parameters
arcpy.ba.DesireLines(in_stores_layer, in_customers_layer, out_feature_class, store_id_field, link_field, {distance_type}, {units}, {cutoff}, {travel_direction}, {time_of_day}, {time_zone})
Name | Explanation | Data Type |
in_stores_layer | The input point layer representing store or facility locations. | Feature Layer |
in_customers_layer | The input point layer representing customers or patrons. | Feature Layer |
out_feature_class | The resultant feature class that will be added to the Contents pane. | Feature Class |
store_id_field | A unique ID field representing a store or facility location. | Field |
link_field | An ID field used to assign individual customers to stores. | Field |
distance_type (Optional) | The method of travel that will be used for distance calculation. Straight Line is the default value. When using Portal for ArcGIS or local data sources, travel mode options are dynamically populated. | String |
units (Optional) | The type of distance- or time-measuring units that will be used when calculating minimal distance. | String |
cutoff (Optional) | The distance beyond which customers will be considered outliers and excluded from consideration during desire line generation. | Double |
travel_direction (Optional) | Specifies the direction of travel that will be used between stores and demand points.
| String |
time_of_day (Optional) | The time at which travel begins. | Date |
time_zone (Optional) | Specifies the time zone that will be used for the time_of_day parameter.
| String |
Code sample
The following Python window script demonstrates how to use the DesireLines function.
import arcpy
arcpy.env.baDataSource = "ONLINE;US;"
arcpy.ba.DesireLines("Hubs", "grocery stores", r"C:\Temp\Output.gdb\Hubs_DesireLines", "Loc_name", "Loc_name", "STRAIGHT_LINE_DISTANCE", "MILES", 15, "TOWARD_STORES", None, "TIME_ZONE_AT_LOCATION")
Environments
Licensing information
- Basic: Requires Business Analyst, ArcGIS Network Analyst extension
- Standard: Requires Business Analyst, ArcGIS Network Analyst extension
- Advanced: Requires Business Analyst, ArcGIS Network Analyst extension