Create Profile by Area Summation (Business Analyst)

License Level:BasicStandardAdvanced

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

Syntax

CreateProfileByAreaSummation_ba (InputFeatureLayer, SegmentationBase, AreaSummationMethod, ProfileFolder, {UseSelectedFeatures}, {InputProfileComments}, {CreateProfileForEachArea}, {FieldNameValueToAddToItemName}, {UseOnlineData})
ParameterExplanationData 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:

  • BLOCK_CENTROID_WEIGHTINGUses Block centroids to determine the number of households or population in each segment for the input polygon.
  • CENTROIDS_IN_TAAll polygons that have their centroids in the input polygon are used to determine the number of households or population in each segment for the input polygon.
  • PARTIALLY_CONTAINED_IN_TAAll polygons that are wholly or partially contained in the input polygon are used to determine the number of households or population in each segment for the input polygon.
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.

  • USE_ALLProfile created for all features in an input layer.
  • USE_SELECTEDProfile created for selected features in an input layer.
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.

  • CREATE_WITH_IDGenerates a profile for each area.
  • CREATE_NO_IDDoes not generate a profile for each area.
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.

  • Checked—use online Business Analyst data.
  • Unchecked—use only locally loaded Business Analyst data.

Select to access online Business Analyst data to use in the analysis.

  • TrueAllows a user to acess online Business Analyst data.
  • FalseA user will only have access to locally loaded Business Analyst data.
Boolean

Code Sample

CreateProfileByAreaSummation Example (Stand-alone Script)
# 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)

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