Skip To Content

Measure Cannibalization (Business Analyst)

Available with Business Analyst license.

Summary

Calculates the amount of overlap between two or more polygons. This overlap refers to the extent at which polygon boundaries coincide.

An optional report can be created detailing overlapped statistics.

Usage

  • The output attribute table includes fields that list the percent of overlap and the proportional comparison of total area for all intersecting input polygons.

  • If polygons do not overlap, the output feature class will contain no geometry or records. The output feature class only contains the overlapping geometry from the input.

  • Polygons must be from a single feature class. Multiple feature classes can be merged into a single feature class using the Merge tool.

Syntax

MeasureCannibalization(in_features, area_id_field, area_description_field, out_feature_class, {store_id_field}, {create_report}, {report_title}, {report_folder}, {report_format})
ParameterExplanationData Type
in_features

The input polygon features to be analyzed for overlap.

Feature Layer
area_id_field

The field that uniquely identifies each feature in the input layer.

Field
area_description_field

The field that describes each feature in the input layer.

Field
out_feature_class

The output feature class that will contain the areas of overlap found in the input layer.

Feature Class
store_id_field
(Optional)

The unique ID that associates a store with each polygon when the inputs are trade areas.

Field
create_report
(Optional)

Specifies whether a report will be generated.

  • CREATE_REPORTA report will be generated.
  • DO_NOT_CREATE_REPORTA report will not be generated . This is the default.
Boolean
report_title
(Optional)

The title of the report. The default value is Measure Cannibalization.

String
report_folder
(Optional)

The output location where the report will be saved.

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

The output format or formats of the report.

String

Derived Output

NameExplanationData Type
output_report

The output report file or files.

File

Code sample

MeasureCannibalization example (Python window)

The following Python window script demonstrates how to use the MeasureCannibalization tool.

import arcpy
arcpy.ba.MeasureCannibalization("SF_Stores_Rings", "AREA_ID", "AREA_DESC", r"C:\ MyProject1\MyProject1.gdb\SF_Stores_RIngs_MeasureCannibalization", "STORE_ID", "CREATE_REPORT", "Measure Cannibalization", r"C:\ MyProject1\MeasureCannibalization", "PDF")

Environments

Licensing information

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

Related topics