Measure Cannibalization (Business Analyst)

License Level:BasicStandardAdvanced

Summary

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

Learn more about how Measure Cannibalization works

Illustration

Measure Cannibalization

Usage

Syntax

MeasureCannibalization_ba (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.

  • TRUEMeasures cannibalization on selected features.
  • FALSEMeasures 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
(Optional)

One or more formats to which the report will be output.

  • Simple XML
  • PDF
  • HTML
  • CSV
  • ZIP
  • XLSV
  • 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.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 Measure Cannibalization tool
  TradeArea = "C:/temp/DetailedCustomerTA.shp"
  Id = "AREA_ID"
  Name = "AREA_DESC"
  Output = "C:/temp/Reports/Cannibalization.shp"
  ReportName = "Cannibalization_Name"
  ReportTitle = "Cannibalization_Report"
  ReportOutput = "C:/temp/Reports"
 
# Create a Measure Cannibalization output
  arcpy.MeasureCannibalization_ba(sTradeArea, sId, sName, sOutput, "false", sReportName, sReportTitle, sReportOutput)
 
# 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