Threshold Trade Areas (Business Analyst)

License Level:BasicStandardAdvanced

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

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.

  • 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
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.

  • 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
UsedAlghoritm
(Optional)

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

  • Use Standard Threshold RingsYour threshold trade areas will be generated based on static rings.
  • Use Threshold Drive TimesYour 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.

  • 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. This is the default.
  • FALSECreates 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)

Access online Business Analyst data to use in the analysis.

  • Checked—Allows you to acess online Business Analyst data.
  • Unchecked—You will only have access to locally loaded Business Analyst data.

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

  • TrueAllows you to acess online Business Analyst data.
  • FalseYou will only have access to locally loaded Business Analyst data. This is the default.
Boolean

Code Sample

ThresholdStaticRing
# Name: ThresholdStaticRing.py
# Description: Creates 3 thresholds rings around selected stores based on total population.
# 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 Trade Areas tool
  StorePath = "C:/temp/sf_stores.shp"
  IdFld = "FID"
  ThresholdLayer = "C:/ArcGIS/Business Analyst/US_2013/Data/BDS/esri_bg.bds"
  FieldThreshold = "TOTPOP_CY"
  OutPath = "C:/temp/ThresholdStaticRings.shp"
   
# Create Threshold Trade Areas
  arcpy.ThresholdStaticRing_ba(StorePath, IdFld, "ALL", ThresholdLayer, FieldThreshold, "100000;200000;300000", 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