Wind Rose Report (Business Analyst)

Summary

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

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

Usage

Syntax

WindRoseReport_ba (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.

  • AllReports are created for all points.
  • SingleReports are created for a single point.
  • SelectedReports 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.

  • IDSelects a single point using the store ID field.
  • NameSelects 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.

  • TrueGenerates the Wind Rose Report on selected features
  • FalseGenerates 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.

  • TRUEExcludes outlying customers.
  • FALSEDoes 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 DegreesMissing Value
  • FeetMissing Value
  • KilometersMissing Value
  • MetersMissing Value
  • MilesMissing Value
  • Nautical MilesMissing Value
  • YardsMissing Value
String
ReportFormats
(Optional)

Select the desired report output format

  • Simple XML
  • PDF
  • HTML
  • CSV
  • ZIP
  • XLSV
  • 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("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 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") 
 
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