Create Profile by Area Summation (Business Analyst)
Summary
Creates segmentation area profiles with standard geography units, study areas, trade areas, and other polygon layers.
Learn more about how Create Profile By Area Summation (Business Analyst) works
Usage
-
The Analysis Extent must be a polygon feature class.
-
In most cases, the Analysis Extent will be a Business Analyst trade area layer.
-
If the Create profile for each separate area is used, the Segmentation Module will create one profile for each polygon in your Profile Base.
-
If you choose to create a profile for each area, the Segmentation module will create each profile and name it based on the ID. For example, if you had CBSA_ for the name of the profile and the ID field was the name of each area, then all your profiles would start with CBSA_ and be followed by the name contained in the area ID field.
Syntax
| Parameter | Explanation | Data Type |
InputFeatureLayer |
The polygon feature class or layer used to create a segmentation area profile. | Feature Layer |
SegmentationBase |
Population or household base for the profile being created. | String |
AreaSummationMethod |
The segmentation data layer is used to aggregate the households or population for the input polygon. This underlying layer can be set in the Business Analyst preferences on the Data tab. There are three methods for creating area profiles:
| String |
ProfileFolder |
The folder where the output profile will be created. The folder name corresponds to the name of the profile used in Business Analyst. For example, a profile created in the folder (C:\My Output Data\Projects\Default Project\Segmentation\Profiles\NewProfile) would be referred to as NewProfile in Business Analyst. | Folder |
UseSelectedFeatures (Optional) |
Determines if profiles will be created for all features, or only selected features.
| Boolean |
InputProfileComments (Optional) |
Optional comments for profile. These comments can include information such as author, source, date, and vintage. | String |
CreateProfileForEachArea (Optional) |
Creates a profile for each separate polygon in your shapefile.
| Boolean |
FieldNameValueToAddToItemName (Optional) |
Each profile generated will be named based on the values in this field. | Field |
UseOnlineData (Optional) |
Determines if online Business Analyst data will be used in the analysis.
Select to access online Business Analyst data to use in the analysis.
| Boolean |
Code Sample
# Name: AssignCustomersByLocation.py
# Description: Creates a geographic based profile.
# Author: Esri
# Import system modules
import arview
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 Create Profile by Area Summation tool
TAPath = "C:/temp/TradeArea.shp"
OutPath = "C:/temp/NewProfile.xml"
# Create Profile by Area Summation
arcpy.CreateProfileByAreaSummation_ba(TAPath, "Total Households", "CENTROIDS_IN_TA", OutPath, "USE_ALL", "#")
# Release extension license
arcpy.CheckInExtension("Business")
except:
print arcpy.GetMessages(2)