Threshold Data Driven Ring (Business Analyst)

License Level:BasicStandardAdvanced

Summary

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

Learn more about how Threshold Data-Driven Ring works

Illustration

Threshold Rings

Usage

Syntax

ThresholdDataDrivenRing_ba (InputFeatureLayer, IDField, All_Or_Single_Or_Selected, ThresholdFeatureLayer, ThresholdPopulationField, RadiusFieldName, OutputFeatureClass, {ByID_Or_ByName}, {Single_Site}, {Donut})
ParameterExplanationData Type
InputFeatureLayer

The input feature class containing center points for the drive-time trade areas. 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

Option defining how to create rings for points in the input feature layer:

  • AllCreates rings for all points.
  • SingleCreates rings for a single point.
  • SelectedCreates 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
RadiusFieldName

The field containing the thresholds for each store point.

Field
OutputFeatureClass

The feature class that will contain the ring features.

Feature Class
ByID_Or_ByName
(Optional)

Field used to select a single point.

  • IDSelects a single point using the store ID field.
  • NameSelects 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
Donut
(Optional)

Defines whether to create nonoverlapping concentric rings, or donut bands.

  • TrueCreates 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.
  • FalseCreates concentric rings.
Boolean

Code Sample

ThresholdDataDrivenRing Example (Stand-alone Script)
# Name: ThresholdDataDrivenRing.py
# Description: Creates thresholds rings around stores.
# Author: Esri

# Import system modules
import arcview
import arcpy

arcpy.AddToolbox("C:\Program Files (x86)\ArcGIS\Desktop10.2\Business Analyst\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")
 
try:
# Acquire extension license 
  arcpy.CheckOutExtension("Business") 
 
# Define input and output parameters for the Threshold Data Driven Ring tool
  StorePath = "C:/temp/sf_stores.shp"
  IdFld = "STORE_ID"
  ThresholdLayer = "C:/ArcGIS/Business Analyst/US_2013/Data/BDS/esri_bg.bds"
  FieldThreshold = "TOTPOP_CY"
  OutPath = "C:/temp/ThresholdDataRings.shp"
 
# Create Threshold Data Driven Ring areas
  arcpy.ThresholdDataDrivenRing_ba(StorePath, IdFld, "ALL", ThresholdLayer, FieldThreshold, "SALES", OutPath)
 
# Release extension license 
  arcpy.CheckInExtension("Business")
 
except:
  print arcpy.GetMessages(2)

Environments

This tool does not use any geoprocessing environments

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Requires Business Analyst
ArcGIS for Desktop Standard: Requires Business Analyst
ArcGIS for Desktop Advanced: Requires Business Analyst
3/3/2014