ArcMap

Summarize Points Report

Available with Business Analyst license.

Summary

Aggregates data from a point layer (such as a customer layer) to a polygon layer (such as a trade area).

Learn more about how Summarize Points Report works

Usage

  • This tool allows you to generate trade areas with appended customer or store-based data.

  • Appended values must be volumetric/numeric.

  • All values appended will be summed.

  • Do not append medians, means, or averages.

  • You can generate a report or a mapping layer with the selected appended values attributed.

  • The mapping output will be thematically mapped based on the point count (that is, the number of points that fall within each polygon).

Syntax

arcpy.ba.SummarizePoints(InputPointLayer, InputBoundaryLayer, IDField, NameField, SummarizePointsFields, {UseSelectedFeatures}, {UseSelectedBoundaries}, {CreateReport}, {ReportTitle}, {ReportFile}, {CreateFeatureClass}, {OutputFeatureClass}, {GroupBy}, {ReportFormats})
ParameterExplanationData Type
InputPointLayer

The point layer containing the data to be appended to the boundary layer.

Feature Layer
InputBoundaryLayer

The boundary layer that will inherit the selected attributes of the point layer.

Feature Layer
IDField

The ID field of the boundary layer.

Field
NameField

The name field associated with the boundary layer.

Field
SummarizePointsFields
[SummarizePointsFields,...]

The fields (or attributes) of the point layer that will be appended and summed to the boundary layer.

Field
UseSelectedFeatures
(Optional)

Uses selected points to summarize to the boundary layer.

  • True —Uses selected points to summarize to the boundary layer.
  • False —Summarizes the points to the boundary layer on all features. This is the default.
Boolean
UseSelectedBoundaries
(Optional)

Uses the selected boundaries for the point summarization.

  • True —Uses the selected boundaries for the point summarization.
  • False —Uses the selected boundaries for the point summarization on all features. This is the default.
Boolean
CreateReport
(Optional)

Generates a report.

  • True —Will generate a Summarize Points report. This is the default.
  • False —Will not generate a Summarize Points report.
Boolean
ReportTitle
(Optional)

The descriptive title on the output report.

String
ReportFile
(Optional)

Determines the directory the Summarize Points report will be saved to.

Folder
CreateFeatureClass
(Optional)

Generates a new boundary layer with the point data summarizations appended.

  • True —Will generate a Summarized Points boundary layer.
  • False —Will not generate a Summarized Points boundary layer. This is the default.
Boolean
OutputFeatureClass
(Optional)

Determines the directory the new boundary layer will be saved to.

Feature Class
GroupBy
(Optional)

The field with which you want to group your points.

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

Select the desired report output format

  • Simple XML
  • PDF
  • HTML
  • CSV
  • ZIP
  • XLSX
  • Stripped XLSX
String

Code sample

SummarizePoints example (stand-alone script)

# Name: SummarizePoints.py
# Description: Summarizes sales data to a trade area in the San Francisco market. 
# 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")

try: 
# Acquire extension license 
  arcpy.CheckOutExtension("Business") 

# Define input and output parameters for the Summarize Points Report tool

  PointInput = "C:/My Output Data/Projects/Default Project/CustLayers/sf_custs/CustomerLayer.shp" 
  Boundary = "C:/My Output Data/Projects/Default Project/TradeAreas/Sub-geography/TradeArea.shp" 
  Id = "ID" 
  Name = "NAME" 
  Fields = "SALES" 
  Report = "SanFranBGs" 
  Output = "C:/My Output Data/Projects/Default Project/Reports/SummarizePoints_0/Report.rpt" 

# Create the Summarize Points report 

  arcpy.SummarizePoints_ba(PointInput, Boundary, Id, Name, Fields, "false", "false", "true", Report, Output) 

# 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