Huff Model Calibration By Real Data (Business Analyst)

Summary

Statistically calibrates the Huff Model using observed customer data for each store location in the study area.

Learn more about how Huff Model Calibration By Real Data works

Usage

Syntax

HuffModelCalibrationByRealData_ba (PotenCustGeogLevel, GeogIDField, CustomersWithAssignedStoreID, AssociatedStoreID, StoreLayer, StoreIDField, StoreAttractionFields, DistanceCalculationMethod, OutputCalibrationFolder, {AnalizeSelectedCustomersOnly}, {ExcludeOutlyingCustomers}, {CutoffDistance}, {MeasureUnits}, {NeedReportOutput}, {ReportTitle}, {ReportFile}, {ReportFormats})
ParameterExplanationData Type
PotenCustGeogLevel

Polygon features representing subareas where potential customers live. Point features (for example, block centroids) that have associated demographic data can also be used.

Feature Layer
GeogIDField

The unique identifier of the Potential Customers Geographic Level.

Field
CustomersWithAssignedStoreID

Point features (typically a Business Analyst customer file) containing customer data and an associated store ID.

Feature Layer
AssociatedStoreID

The store ID field in the customer layer that assigns each customer to a store.

Field
StoreLayer

The layer that contains the competitive points (usually stores) used to determine how sales are influenced and distributed across the analysis area.

Feature Layer
StoreIDField

The unique identifier of the competitive store layer.

Field
StoreAttractionFields
[StoreAttractionFields,...]

The values that measure how attractive a store is to consumers.

Field
DistanceCalculationMethod

Assigns the method used to calculate distances between geographic areas defined by the potential customers layer parameter and stores from the competitive store layer.

  • STRAIGHT_LINE_DISTANCEEuclidean (as the crow flies) approach.
  • DRIVE_DISTANCEDriving distance measured in units of distance.
  • DRIVE_TIMEDriving time measured in units of time.
String
OutputCalibrationFolder

The output folder that will contain the Huff Model calibration result file.

Folder
AnalizeSelectedCustomersOnly
(Optional)

Uses only selected features to generate the Huff Model Calibration By Real Data.

  • TrueGenerates the Huff calibration model on selected features in the customers layer.
  • FalseGenerates the Huff calibration model on all features in the customers layer.
Boolean
ExcludeOutlyingCustomers
(Optional)

Optionally sets a cutoff distance to remove outlying points from the model.

  • TrueExcludes outlying customers.
  • FalseIncludes all customers in the analysis.
Boolean
CutoffDistance
(Optional)

The threshold to exclude outlying customers from the analysis.

Double
MeasureUnits
(Optional)

The units used with the distance values. By default, the units defined in the Business Analyst preferences will be selected.

  • Minutes
  • Decimal Degrees
  • Feet
  • Kilometers
  • Meters
  • Miles
  • Nautical Miles
  • Yards
String
NeedReportOutput
(Optional)

Generates a Huff model calibration report based on real data.

  • TrueGenerates the Huff calibration report.
  • FalseWill not generate the Huff calibration report.
Boolean
ReportTitle
(Optional)

The report title for the calibration report

String
ReportFile
(Optional)

The name for the calibration report file.

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

Format of the output report. More than one format may be selected.

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

Code Sample

HuffModelCalibrationByRealData (Stand-alone Script)
 
# Name: HuffModelCalibrationByRealData.py
# Description: Generates a calibrated model around two San Francisco stores using Sales as a predictor.
# Author: ESRI

# Import system modules
import arcview
import arcpy

arcpy.ImportToolbox("C:\Program Files\ArcGIS\Desktop10.0\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")


try:
  # Acquire extension license 
  arcpy.CheckOutExtension("Business")
  arcpy.CheckOutExtension("Network") 
 
 
  # Define input and output parameters for the Huff Model Calibration by Real Data tool
  Potential = "C:/Program Files/ArcGIS/Desktop10.0/Business Analyst/Data/BDS/esri_bg.bds"
  SalesId = "ID"
  Cust = "C:/temp/sf_cust.shp"
  AssocStoreId = "STORE_ID"
  Store = "C:/temp/sf_stores.shp"
  StoreId = "STORE_ID"
  AttractionField = "SALES"
  OutPath = "C:/temp/Calibration_Realdata"
 
  # Create Huff Model Calibration by Real Data
  arcpy.HuffModelCalibrationByRealData_ba(Potential, SalesId, Cust, AssocStoreId, Store, StoreId, AttractionField, "DRIVE_TIME", OutPath, "false", "false")
 
  # Release extension license 
  arcpy.CheckInExtension("Business")
  arcpy.CheckInExtension("Network")
 
except:
  print arcpy.GetMessages(2)

Environments

This tool does not use any geoprocessing environments

Related Topics

Licensing Information

ArcView: Requires Business Analyst
ArcEditor: Requires Business Analyst
ArcInfo: Requires Business Analyst

11/8/2010