Original Huff Model (Business Analyst)

Summary

Creates a probability surface to predict the sales potential of an area based on distance and an attractiveness factor.

Learn more about how Original Huff Model works.

Usage

Syntax

HuffModelOriginal_ba (SalesPotentialLayer, PotentialSalesFldName, StoreLayer, AttractivenessField, WayToDefineStoreLocation, RadiusOfCovering, {MeasureUnits}, DistanceCoefficient, Attractiveness, OutputFeatureClass, {Longitude}, {Latitude}, {PotentialStoreLayer}, {PotentialStoreOID})
ParameterExplanationData Type
SalesPotentialLayer

The features used to calculate the sales potential of the Huff Model.

Feature Layer
PotentialSalesFldName

The field containing the values used to calculate the sales potential of the Huff Model.

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
AttractivenessField

The attribute field that determines how attractive each competitor is. In many cases, the size of the store is used as a surrogate for attractiveness.

Field
WayToDefineStoreLocation

Determines how the potential layer will be selected.

  • BY_COORDINATESEnters latitude and longitude coordinates as the center point for the potential layer.
  • FROM_LAYERSelects a point layer from an existing layer as the potential site.
String
RadiusOfCovering

Sets the radius of the Huff Model. The model output will extend from the potential site location to this distance.

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
DistanceCoefficient

The value that determines how much of a factor travel distance is to the consumer.

Double
Attractiveness

The value that measures how attractive the potential store is to consumers.

Double
OutputFeatureClass

The output feature class that will contain the Huff Model results.

Feature Class
Longitude
(Optional)

The x-coordinate (longitude) for the potential site.

Double
Latitude
(Optional)

The y-coordinate (latitude) for the potential site.

Double
PotentialStoreLayer
(Optional)

The existing point feature class used to define the potential store location.

Feature Layer
PotentialStoreOID
(Optional)

The unique identifier for the potential store location.

Long

Code Sample

HuffModelOriginal Example (Stand-alone Script)
# Name: HuffModelOriginal.py
# Description: Creates a Huff Model to estimate dollars spent on vehicle maintenance in the San Francisco Market 
# 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") 
 
  # Define input and output parameters for the Original Huff Model tool
  SalesLayer = "C:/Program Files/ArcGIS/Desktop10.0/Business Analyst/Data/BDS/esri_bg.bds"
  SalesId = "X6015_X"
  CompLayer = "C:/temp/sf_stores.shp"
  AttractiveField = "SALES"
  OutPath = "C:/temp/Huff_Model.shp"
 
  # Create Original Huff Model  
  arcpy.HuffModelOriginal_ba(SalesLayer, SalesId, CompLayer, AttractiveField, "BY_COORDINATES", "5", "Miles", "-1.5", "50000", OutPath, "-122.46", "37.76")
 
  # Release extension license 
  arcpy.CheckInExtension("Business")
            
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