Static Rings (Business Analyst)

Summary

Creates a new feature class of ring trade area features using a set of radii

Learn more about how Static Rings works

Illustration

Usage

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

• Valid numeric distances must be used when defining radii values. Negative distances cannot be used for ring radii.

• Selecting ALL in the Sites To Use parameter will create rings for each point feature in the store layer input feature class.

• The Remove Overlap parameter uses Thiessen polygons to remove overlap between output ring polygons.

• Donut rings create output polygons that are bands. For example, if three radii are entered with values of 1, 2, and 3 miles, three output bands would be created with 0–1-, 1–3-, and 3–5-mile rings.

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

Syntax

StaticRings_ba (InputFeatureLayer, IDField, All_Or_Single_Or_Selected, RingsCollection, {MeasureUnits}, OutputFeatureClass, {ByID_Or_ByName}, {Single_Site}, {RemoveOverlap}, {Donut})

Parameter	Explanation	Data 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 —Rings are created for all points. Single —Rings are created for a single point. Selected —Rings are created for all selected points in ArcMap.	String
RingsCollection [RingsCollection,...]	The distances, in ascending size, used to create rings around the input features.	Double
MeasureUnits (Optional)	The units used with the distance values. By default, the units defined in the Business Analyst preferences will be selected. Decimal Degrees Feet Kilometers Meters Miles Nautical Miles Yards	String
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
RemoveOverlap (Optional)	Creates overlapping concentric rings or removes overlap. TRUE —Uses Thiessen polygons to remove overlap between output ring polygons. FALSE —Output ring features are created with overlap. This is the default.	Boolean
Donut (Optional)	Creates 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

Code Sample

StaticRings Example (Stand-alone Script)

# Name: StaticRings.py
# Description: Creates 1,2, and 3 mile ring trade areas around stores in San Francisco.
# 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 Static Rings tool
  StorePath = "C:/temp/sf_stores.shp"
  IdFld = "STORE_ID"
  OutPath = "C:/temp/RingOutput.shp"
 
# Create static ring trade areas
  arcpy.StaticRings_ba(StorePath, IdFld, "ALL", "1;2;3", "Miles", OutPath)
 
# Release extension license 
  arcpy.CheckInExtension("Business")
    
except:
  print arcpy.GetMessages(2)

Environments

This tool does not use any geoprocessing environments

Licensing Information

ArcGIS for Desktop Basic: Requires Business Analyst

ArcGIS for Desktop Standard: Requires Business Analyst

ArcGIS for Desktop Advanced: Requires Business Analyst