ArcMap

Measure Cannibalization

Available with Business Analyst license.

Summary

Calculates the amount of overlap between two or more trade areas.

Learn more about how Measure Cannibalization works

Illustration

Measure Cannibalization

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.

  • This tool is primarily used to examine the amount of overlap between two or more trade areas.

  • In most cases, the trade area layers will be trade areas created with Business Analyst.

  • Only overlapping trade areas are valid inputs for this tool.

  • The output feature class is created from the actual area of overlap in the trade area features.

  • If trade areas do not overlap, the output feature class will be the same trade area input feature class.

Syntax

arcpy.ba.MeasureCannibalization(InputLayer, IDField, NameField, OutputFeatureClass, {UseSelectedFeatures}, {ReportName}, {ReportTitle}, {ReportOutputDirectory}, {ReportFormats})
ParameterExplanationData Type
InputLayer

The input feature class containing the trade areas used to determine amount of cannibalization.

Feature Layer
IDField

Unique ID field in the trade area layer.

Field
NameField

Unique name field in the trade area layer.

Field
OutputFeatureClass

The output feature class that will contain the overlapped features.

Feature Class
UseSelectedFeatures
(Optional)

The features used to measure cannibalization.

  • TRUE —Measures cannibalization on selected features.
  • FALSE —Measures cannibalization on all features. This is the default.
Boolean
ReportName
(Optional)

Name of the report.

String
ReportTitle
(Optional)

Title of the report.

String
ReportOutputDirectory
(Optional)

Report is created in this output folder.

Folder
ReportFormats
[ReportFormats,...]
(Optional)

One or more formats to which the report will be output. If you are using the Python function call, enter the values as a String in the following format: "FirstFormat; SecondFormat; ThirdFormat", etc. For example: "html;pdf;s.xlsx;s.xml;xlsx" (A String of desired format names delimited by semi-colons.)

  • Simple XML —Enter "s.xml" for simple XML
  • PDF —Enter "pdf" for PDF
  • HTML —Enter "html" for HTML
  • CSV —Enter "csv" for CSV
  • ZIP —Enter "zip" for ZIP
  • XLSX —Enter "xlsx" for XLSX
  • Stripped XLSX —Enter "s.xlsx" for stripped XLSX
String

Code sample

MeasureCannibalzation Example (Stand-alone Script)
# Name: MeasureCannibalization.py
# Description: Measures cannibalization between two 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 Measure Cannibalization tool
InputLayer = "C:/temp/DetailedCustomerTA.shp"
IDField = "AREA_ID"
NameField = "AREA_DESC"
OutputFeatureClass = "C:/temp/Reports/Cannibalization.shp"
ReportName = "Cannibalization_Name"
ReportTitle = "Cannibalization_Report"
ReportOutputDirectory = "C:/temp/Reports"
ReportFormats="html;pdf;s.xlsx;s.xml;xlsx"
 
# Create a Measure Cannibalization output
arcpy.MeasureCannibalization_ba(InputLayer, 
						IDField, 
						NameField, 
						OutputFeatureClass, 
						UseSelectedFeatures, 
						ReportName, 
						ReportTitle, 
						ReportOutputDirectory, 
						ReportFormats)
 
# 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

Related topics