Remove Trade Area Overlap

Available with Business Analyst license.

Summary

Removes overlap (cannibalization) between trade areas

Illustration

Usage

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

• The Trade Area Layer must be a polygon feature class.

• In most cases, the Trade Area Layer will be a trade area created with Business Analyst.

• The Remove Overlap Method parameter has two choices:

  • THIESSEN_POLYGONS method will remove overlap using straight lines.
  • The GRID method will remove overlap with a line that reflects the shape and curve of the input polygon feature class.

• If trade areas do not overlap, the output feature class will contain the features from the input Trade Area Layer.

Syntax

arcpy.ba.RemoveTAOverlap(InputFeatureLayer, AssociatedStoreID, {CenterOfTA}, ApproachToRemoveOverlap, OutputFeatureClass, {StoreLayer}, {StoreIDField}, {WayToDefineWeights}, {WeightField})

Parameter	Explanation	Data Type
InputFeatureLayer	The input features containing the overlapping trade areas.	Feature Layer
AssociatedStoreID	Unique ID field in the trade area layer.	Field
CenterOfTA (Optional)	Field used to define the way a centroid is derived. USE_CENTROID —Uses the geographic centroid of the trade areas. This is the default. USE_STORE_LAYER —Uses the existing store layer for the centroid of the trade areas.	String
ApproachToRemoveOverlap	Defines the approach used to remove overlap between trade areas. THIESSEN_POLYGONS —Removes the overlap by drawing straight lines of equal distance between two adjacent polygons. This is the default. GRID —Takes into account weights of the stores and shape of the overlapping polygon to make the division more natural.	String
OutputFeatureClass	The feature class containing the new trade area features.	Feature Class
StoreLayer (Optional)	The input features containing center points for the overlapping trade areas. In most cases, this will be a Business Analyst store layer.	Feature Layer
StoreIDField (Optional)	Unique ID field in the store layer.	Field
WayToDefineWeights (Optional)	Method for removing overlap when using the grid approach. USE_AREA_OF_TA —Uses the trade area as a weight. This is the default. USE_WEIGHT_FIELD —Gives the option to select a numeric variable from the store layer as the weight for the trade area to remove the overlap. EQUAL_WEIGHTS —Uses the actual midpoint of the intersecting grid line to remove the overlap.	String
WeightField (Optional)	Field used to determine how the trade area overlap is influenced. Required when the grid approach and the weight definition method are set to USE_WEIGHT_FIELD.	Field

Code sample

RemoveTAOverlap Example (Stand-alone Script)

# Name: RemoveTAOverlap.py
# Description: Removes overlap between selected trade areas.
# Author: Esri

# Import system modules
import arcview
import arcpy

arcpy.ImportToolbox(r"C:\Program Files (x86)\ArcGIS\Desktop10.8\Business Analyst\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")
 
# Acquire extension license 
arcpy.CheckOutExtension("Business") 
 
# Define input and output parameters for the Remove Trade Area Overlap tool
InputFeatureLayer = "C:/temp/overlap.shp"
AssociatedStoreID = "<none>"
CenterOfTA = "USE_CENTROID"
ApproachToRemoveOverlap = "THIESSEN_POLYGONS"
OutputFeatureClass = "C:/temp/RAPolygon.shp"
StoreLayer = ""
StoreIDField = ""
WayToDefineWeights = ""
WeightField = ""
 
# Remove overlap based on trade areas
arcpy.RemoveTAOverlap_ba(InputFeatureLayer, 
						AssociatedStoreID, 
						CenterOfTA,
						ApproachToRemoveOverlap,
						OutputFeatureClass,
						StoreLayer,
						StoreIDField,
						WayToDefineWeights,
						WeightField)
 
# Release extension license 
arcpy.CheckInExtension("Business")

Environments

This tool does not use any geoprocessing environments.

Licensing information

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