Available with Business Analyst license.
Summary
Profiles demographic attributes of customer data based on a selected demographic or custom data layer using the Principal Component Analysis approach.
Learn more about how Customer Prospecting By Using PCA works
Usage
It is recommended that the Boundary PCA Eigenvalue parameter value of 1 be left as the default based on the widely accepted Kaiser criterion.
When choosing the Number of Features to Rank, you can limit the number of features displayed in the output in the analysis. All the features are analyzed with this approach, but only the top N features will be displayed.
Syntax
arcpy.ba.PCACustomerProspecting(InputBoundaryLayer, InputGeographyLevel, OutputFeatureClass, DMQFile, FSRankFeatNum, {UserDefinedBoundVal})
Parameter | Explanation | Data Type |
InputBoundaryLayer | The boundary layer that defines the extent of the data to be analyzed. | Feature Layer |
InputGeographyLevel | The input feature class that contains the data to be used in the analysis. | Feature Layer |
OutputFeatureClass | The output feature class that will contain the customer prospecting data. The output feature class will be ranked based on similarity to the master site. | Feature Class |
DMQFile | The definition input file generated in Customer Prospecting (Business Analyst) that sets the parameters to filter the geography level. | File |
FSRankFeatNum | Defines the number of features you can rank. For example, if you selected 10 for the number of features to rank, the top 10 features would be ranked, which may include your master site if it is included in your target layer. | Long |
UserDefinedBoundVal (Optional) | The Eigenvalue to use. It is recommended that you use the default value of one. | Double |
Code sample
PCACusomterProspecting example (stand-alone script)
# Name: PCACusomterProspecting.py
# Description: Creates a geographic output that ranks the top X geographies that match the inputted profile.
# 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 the parameters for the Customer Prospecting using PCA tool
InputBoundaryLayer = "C:/temp/Boundary.shp"
InputGeographyLevel = "C:/ArcGIS/Business Analyst/US_2022/Data/Demographic Data/BlockGroups_bg.bds"
OutputFeatureClass= "C:/temp/PCA_Demo_Prospect.shp"
DMQFile= "C:/temp/DMQ_output.dmq"
FSRankFeatNum = 6
# Create Customer Prospecting output file
arcpy.PCACustomerProspecting_ba(InputBoundaryLayer,
InputGeographyLevel,
OutputFeatureClass,
DMQFile,
FSRankFeatNum)
# 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