ArcMap

Wind Rose Report

Available with Business Analyst license.

Summary

Offers a visual representation of the frequency and direction of customer locations.

Learn more about how Wind Rose Report (Business Analyst) works

Usage

  • This tool allows you to examine the pattern and distribution of customers in relation to a corresponding store location.

  • The customer layer must be a point feature layer.

  • In ArcMap, customer points will only be used in the report if they are within the active study area or analysis extent.

  • The Wind Rose chart divides a customer layer into different geographic sectors (N, NE, NW, S, SE, and so on). Because the sectors divide the entire distribution of customer locations around a store location, a circular buffer is created around the store that encompasses all the store points. This circle is then divided into sectors.

  • You can use the Cutoff Distance option to limit the size of the circular buffer created around each store location.

  • An even number of sectors is recommended.

  • A value of at least four sectors is recommended.

  • The proportion of customers in each sector can be calculated using a weight value associated with each customer record.

  • Use the Customer Setup tools if your customers are not already associated with a store location.

Syntax

arcpy.ba.WindRoseReport(InputFeatureLayer, IDField, All_Or_Single_Or_Selected, CustomerLayer, InCustomerStoreIDField, CustomerWeightField, NumberOfSectors, ReportName, ReportTitle, OutputFolder, {ByID_Or_ByName}, {Single_Site}, {UseSelectedFeatures}, {ExcludeOutlyingCustomers}, {CutoffDistance}, {MeasureUnits}, {ReportFormats})
ParameterExplanationData Type
InputFeatureLayer

The input feature class containing center points for the report. In most cases, this will be a Business Analyst store layer. Distance and direction will be measured from these points.

Feature Layer
IDField

Unique ID field in the center points (store) layer. Distances will be calculated from these points.

Field
All_Or_Single_Or_Selected

Creates Wind Rose Reports for the points in the input feature layer.

  • All —Reports are created for all points.
  • Single —Reports are created for a single point.
  • Selected —Reports are created for selected points in ArcMap.
String
CustomerLayer

The input feature class containing the points for the customer distribution. In most cases, this will be a Business Analyst customer layer. Distance and direction will be measured from the store center points to features in this point layer.

Feature Layer
InCustomerStoreIDField

The store ID field that will be used to identify which customers are associated with each store.

Field
CustomerWeightField

The proportion of customers in each sector can be calculated by using a weight value associated with each customer record. If you do not want to use a weight field, set the weight field to the first value of <none>.

Field
NumberOfSectors

Determines the number of sectors in the Wind Rose diagram.

Long
ReportName

Name for the report file.

String
ReportTitle

Title for the report.

String
OutputFolder

The report is created in this output directory.

Folder
ByID_Or_ByName
(Optional)

Field used to select a single point.

  • ID —Selects a single point using the store ID field.
  • Name —Selects a single point using the store name field.
String
Single_Site
(Optional)

ID or name of store to be used as the single point.

String
UseSelectedFeatures
(Optional)

Uses selected features to generate the Wind Rose Report.

  • True —Generates the Wind Rose Report on selected features
  • False —Generates the Wind Rose Report on all features. This is the default.
Boolean
ExcludeOutlyingCustomers
(Optional)

Sets a cutoff distance to remove outlying feature points from the report.

  • TRUE —Excludes outlying customers.
  • FALSE —Does not exclude outlying customers.
Boolean
CutoffDistance
(Optional)

The threshold beyond which 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.

  • Decimal Degrees —The unit is in decimal degrees.
  • Feet —The unit is in feet.
  • Kilometers —The unit is in kilometers.
  • Meters —The unit is in meters.
  • Miles —The unit is in miles.
  • Nautical Miles —The unit is in nautical miles.
  • Yards —The unit is in yards.
String
ReportFormats
[ReportFormats,...]
(Optional)

Select the desired report output format

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

Code sample

WindRoseReport example (stand-alone script)

# Name: WindRoseReport.py
# Description: Creates a Wind Rose report.
# 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 input and output parameters for the Wind Rose Report tool
  Store = "C:/temp/sf_stores.shp"
  Cust = "C:/temp/sf_cust.shp"
  Id = "STORE_ID"
  StoreIdLink = "STORE_ID"
  Weight = "SALES"
  Output = "C:/temp/WindRoseOutput"
 
# Create Wind Rose reports
  arcpy.WindRoseReport_ba(Store, Id, "ALL", Cust, StoreIdLink, Weight, "5", "Wind Rose Report", "Wind Rose Report", Output)
 
# 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

Related topics