ArcMap

Threshold Trade Areas

Available with Business Analyst license.

Summary

Creates rings around your stores. The radii of the rings are determined by expanding from the store location until they meet your criteria.

Illustration

Threshold trade areas example

Usage

  • The spatial reference of the output feature class will be the same as the store layer.

  • The store layer input feature class must be point features.

  • In most cases, the store layer input feature layer will be a Business Analyst store layer.

  • Valid numeric units must be used when defining radii values. Negative values cannot be used for threshold radii.

  • Selecting all sites to use will create rings for each point feature in the ring centers (stores) input feature class.

  • In ArcMap, trade areas will only be created for features that are within the active study area or analysis extent.

  • The threshold layer must be a point or polygon feature class and be set up as a Business Analyst Dataset (BDS) layer. In most cases, you should select the block group or block points layer.

Syntax

ThresholdStaticRing_ba (InputFeatureLayer, IDField, All_Or_Single_Or_Selected, ThresholdFeatureLayer, ThresholdPopulationField, {MeasureUnits}, RingsCollection, OutputFeatureClass, {ByID_Or_ByName}, {Single_Site}, {UsedAlghoritm}, {Donut}, {BarrierFeatureClasses}, {UseOnlineData})
ParameterExplanationData Type
InputFeatureLayer

The input feature class containing center points for the rings. In most cases, this will be a Business Analyst store layer.

Feature Layer
IDField

Unique ID field in the ring center (store) layer.

Field
All_Or_Single_Or_Selected

Creates rings for points in the input feature layer.

  • All —Creates rings for all points.
  • Single —Creates rings for a single point.
  • Selected —Creates rings for all selected points in ArcMap.
String
ThresholdFeatureLayer

The input feature class containing the threshold data that will determine the radii.

Feature Layer
ThresholdPopulationField

The threshold value field contained in the threshold layer.

Field
MeasureUnits
[MeasureUnits,...]
(Optional)

The units used with the distance values. By default, the units defined in the Business Analyst preferences will be selected.

  • Minutes
  • Feet
  • Kilometers
  • Meters
  • Miles
  • Nautical Miles
  • Yards
String
RingsCollection
RingsCollection;RingsCollection...

The number of radii and the threshold values for each ring.

Double
OutputFeatureClass

The feature class that will contain the ring features.

Feature Class
ByID_Or_ByName
(Optional)

Field used to select a single point.

  • ID —Selects a single point using the store ID field.
  • Name —Selects a single point using the store name field.
String
Single_Site
(Optional)

ID or name of store to be used as the single point.

String
UsedAlghoritm
(Optional)

The technique that will be used the generate the threshold trade areas.

  • Use Standard Threshold Rings —Your threshold trade areas will be generated based on static rings.
  • Use Threshold Drive Times —Your threshold trade areas will be generated based on drive-time trade areas.
String
Donut
(Optional)

Defines whether to create nonoverlapping concentric rings or donut bands.

  • TRUE —Creates output polygons that are donut rings. For example, if three radii (1, 2, and 3 miles) are entered, three output bands would be created with 0–1-, 1–3-, and 3–5-mile rings. This is the default.
  • FALSE —Creates concentric rings.
Boolean
BarrierFeatureClasses
[BarrierFeatureClasses,...]
(Optional)

You can place point, line, or polygon barriers when using drive time or drive distance algorithms to calculate distances.

Feature Layer
UseOnlineData
(Optional)

Select to access online Business Analyst data to use in the analysis.

  • True —Allows you to acess online Business Analyst data.
  • False —You will only have access to locally loaded Business Analyst data. This is the default.
Boolean

Code sample

ThresholdStaticRing example (stand-alone script)

# Name: ThresholdTradeAreas.py
# Description: Creates 3 thresholds rings around selected stores based on total population.
# Author: Esri

# Import system modules
import arcview
import arcpy

arcpy.ImportToolbox(r"C:\Program Files (x86)\ArcGIS\Desktop10.6\Business Analyst\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")

# Acquire extension license 
arcpy.CheckOutExtension("Business")

# Define input and output parameters for the Data Driven Rings tool
InputFeatureLayer = "C:/temp/sf_store.shp"
IDField = "STORE_ID"
All_Or_Single_Or_Selected = "ALL"
ThresholdFeatureLayer = "C:/ArcGIS/Business Analyst/US_2017/Data/Demographic Data/esri_bg.bds"
ThresholdPopulationField = "TOTPOP_CY"
MeasureUnits = ""
RingsCollection = "100000;200000;300000"
OutputFeatureClass = "C:/temp/RingOutput.shp"
ByID_Or_ByName = ""
Single_Site = ""
UsedAlgorithm = ""
BarrierFeatureClasses = ""
UseOnlineData = "False"
Donut = "False"

 
# Create data driven rings trade areas    
arcpy.ThresholdStaticRing_ba(InputFeatureLayer, 
						IDField, 
						All_Or_Single_Or_Selected, 
						ThresholdFeatureLayer,
						ThresholdPopulationField,
						MeasureUnits, 
						RingsCollection,
						OutputFeatureClass, 
						ByID_Or_ByName, 
						Single_Site, 
						UsedAlgorithm, 
						BarrierFeatureClasses,
						UseOnlineData,
						Donut)
 
# Release extension license 
arcpy.CheckInExtension("Business")

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics