Generate Threshold Rings (Business Analyst)

Disponible con licencia de Business Analyst.

Resumen

Creates a feature class of ring trade areas that expand around point features until the threshold value is reached.

Uso

  • The size of the output rings is determined by the Threshold Values parameter value provided for a selected Threshold Variable parameter value from the active Business Analyst dataset.

  • The Threshold Variable parameter accepts only variables of Count type. Median, Average, Percent, or Index cannot be used.

  • Multiple threshold rings can be created around each input by typing individual values into separate threshold value text boxes.

  • The ID Field parameter value uniquely identifies the point location around which threshold rings will be created.

Parámetros

EtiquetaExplicaciónTipo de datos
Input Features

The input point feature layer.

Feature Layer
Output Feature Class

The output feature class containing the threshold rings.

Feature Class
Threshold Variable

The selected Business Analyst dataset variable to which the threshold value will be applied.

Threshold variables must be numeric. No other statistic type is supported.

String
Threshold Values

The threshold variable value that will determine the size of the output rings. The rings will expand until they contain the threshold value of the selected variable.

Double
Distance Units
(Opcional)

The distance units that will be used with the threshold values.

String
ID Field
(Opcional)

The ID that uniquely identifies each input point and is included in the output as an attribute.

Field
Input Method
(Opcional)

Specifies the type of value that will be used for each drive time.

  • ValuesA constant value will be used (all trade areas will be the same size). This is the default.
  • ExpressionThe values from a field or an expression will be used (trade areas can be different sizes).
String
Expression
(Opcional)

A fields-based expression that will be used to calculate the radii.

SQL Expression
Minimum Step
(Opcional)

The minimum distance between one threshold area candidate and the next as the model approaches the threshold value to prevent infinite iterations.

Double
Threshold Percent Difference
(Opcional)

The maximum percentage difference between the target value and threshold value that will be used when determining the threshold drive time, for example, 5 percent. The default value is 5.

Double

arcpy.ba.GenerateThresholdRingTradeArea(in_features, out_feature_class, threshold_variable, threshold_values, {units}, {id_field}, {input_method}, {expression}, {minimum_step}, {target_percent_diff})
NombreExplicaciónTipo de datos
in_features

The input point feature layer.

Feature Layer
out_feature_class

The output feature class containing the threshold rings.

Feature Class
threshold_variable

The selected Business Analyst dataset variable to which the threshold value will be applied.

Threshold variables must be numeric. No other statistic type is supported.

String
threshold_values
[threshold_values,...]

The threshold variable value that will determine the size of the output rings. The rings will expand until they contain the threshold value of the selected variable.

Double
units
(Opcional)

The distance units that will be used with the threshold values.

String
id_field
(Opcional)

The ID that uniquely identifies each input point and is included in the output as an attribute.

Field
input_method
(Opcional)

Specifies the type of value that will be used for each drive time.

  • VALUESA constant value will be used (all trade areas will be the same size). This is the default.
  • EXPRESSIONThe values from a field or an expression will be used (trade areas can be different sizes).
String
expression
(Opcional)

A fields-based expression that will be used to calculate the radii.

SQL Expression
minimum_step
(Opcional)

The minimum distance between one threshold area candidate and the next as the model approaches the threshold value to prevent infinite iterations.

Double
target_percent_diff
(Opcional)

The maximum percentage difference between the target value and threshold value that will be used when determining the threshold drive time, for example, 5 percent. The default value is 5.

Double

Muestra de código

GenerateThresholdRingTradeArea example (Python window)

The following Python window script demonstrates how to use the GenerateThresholdRingTradeArea function.

import arcpy
arcpy.ba.GenerateThresholdRingTradeArea("SF_Custs",r"C:\Project1.gdb\SF_Custs_GenerateThresholdRingTradeArea","populationtotals.totpop_cy",[50000,
100000], "MILES", "STORE_ID", Values, None)

Información de licenciamiento

  • Basic: Requiere Business Analyst
  • Standard: Requiere Business Analyst
  • Advanced: Requiere Business Analyst

Temas relacionados