Add Point Layer Based Suitability Criteria (Business Analyst)

Available with Business Analyst license.

Summary

Adds criteria based on spatial relationships between the input layer and a specified point layer.

Usage

• You can use the Make Suitability Analysis Layer tool to create the analysis layer.

• The influence for the point can be based on count, a weight, or minimum distance.

• For weight, a numeric field and Statistics Type parameter value must be specified.

• For minimum distance, the centers of the sites must be specified. The centers of the sites are used for calculating the distance to the points.

• Set the influence for each criteria using the Set Criteria Property tool.

Parameters

Dialog

Label	Explanation	Data Type
Input Suitability Analysis Layer	The Suitability Analysis layer that will be used in the analysis.	Feature Layer; Group Layer
Site Layer ID Field	A field containing unique values for each record in the Suitability Analysis layer.	String
Point Features	The layer containing point locations that will be added as criteria based on the spatial relationship to the Suitability Analysis layer.	Feature Layer
Criteria Type	Specifies the type of spatial relationship that will be used as criteria. Count—A count of points that fall within each Suitability Analysis layer polygon will be used as criteria. This is the default. Weight—Field-weighted criteria of points that fall within each Suitability Analysis polygon based on the user-selected statistical type will be used as criteria. Minimal Distance—The distance from the closest point to each of the Suitability Analysis layer centroids will be used as criteria.	String
Distance Type (Optional)	The method of travel that will be used to calculate the minimal distance.	String
Measure Units (Optional)	The unit of measure that will be used when calculating minimal distance.	String
Site Centers Features (Optional)	The point layer that will be used as site centers. This point layer will replace default polygon centroids of the Suitability Analysis layer.	Feature Layer
Site Centers Layer ID Field (Optional)	A field in the Site Centers Features parameter value that uniquely identifies each record.	Field
Weight Field	Numeric fields that exist in a point layer that will be selected for weighting.	Field
Statistics Type (Optional)	Specifies the type of statistical operation that will be applied to the weighted field. Sum—The total of the field values will be calculated for each point feature. Average—The average field value will be calculated for each point feature. Standard Deviation—The standard deviation of the field values will be calculated for each point feature. Minimum—The smallest field value will be determined for each point feature. Maximum—The largest field value will be determined for each point feature.	String
Cutoff (Optional)	The distance beyond which points will not be considered in the calculation.	Double

Derived Output

Label	Explanation	Data Type
Output Suitability Analysis Layer	A container for the output layer.	Feature Layer; Group Layer
Output Criteria Name	The name of the criteria that will be added to the Suitability Analysis layer.	String

Python

arcpy.ba.AddPointLayerBasedSuitabilityCriteria(in_analysis_layer, site_layer_id_field, in_point_features, criteria_type, {distance_type}, {units}, {in_site_centers_features}, {site_centers_id_field}, weight_field, {statistics_type}, {cutoff_distance})

Name	Explanation	Data Type
in_analysis_layer	The Suitability Analysis layer that will be used in the analysis.	Feature Layer; Group Layer
site_layer_id_field	A field containing unique values for each record in the Suitability Analysis layer.	String
in_point_features	The layer containing point locations that will be added as criteria based on the spatial relationship to the Suitability Analysis layer.	Feature Layer
criteria_type	Specifies the type of spatial relationship that will be used as criteria. COUNT—A count of points that fall within each Suitability Analysis layer polygon will be used as criteria. This is the default. WEIGHT—Field-weighted criteria of points that fall within each Suitability Analysis polygon based on the user-selected statistical type will be used as criteria. MINIMAL_DISTANCE—The distance from the closest point to each of the Suitability Analysis layer centroids will be used as criteria.	String
distance_type (Optional)	The method of travel that will be used to calculate the minimal distance.	String
units (Optional)	The unit of measure that will be used when calculating minimal distance.	String
in_site_centers_features (Optional)	The point layer that will be used as site centers. This point layer will replace default polygon centroids of the Suitability Analysis layer.	Feature Layer
site_centers_id_field (Optional)	A field in the in_site_centers_features parameter value that uniquely identifies each record.	Field
weight_field	Numeric fields that exist in a point layer that will be selected for weighting.	Field
statistics_type (Optional)	Specifies the type of statistical operation that will be applied to the weighted field. SUM—The total of the field values will be calculated for each point feature. AVE—The average field value will be calculated for each point feature. STD_DEV—The standard deviation of the field values will be calculated for each point feature. MIN—The smallest field value will be determined for each point feature. MAX—The largest field value will be determined for each point feature.	String
cutoff_distance (Optional)	The distance beyond which points will not be considered in the calculation.	Double

Derived Output

Name	Explanation	Data Type
out_analysis_layer	A container for the output layer.	Feature Layer; Group Layer
out_criteria_name	The name of the criteria that will be added to the Suitability Analysis layer.	String

Code sample

AddPointLayerBasedSuitabilityCriteria example (Python window)

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

import arcpy
arcpy.ba.AddPointLayerBasedSuitabilityCriteria("Suitability Analysis layer", "OBJECTID", r"Data\Business Data\USA_SHC_2018.gdb\us_shc", "WEIGHT", None, None, None, None, "GLA", "SUM", None)

Environments

Current Workspace, Data Source, Network Source

Licensing information

• Basic: Requires Business Analyst, ArcGIS Network Analyst extension
• Standard: Requires Business Analyst, ArcGIS Network Analyst extension
• Advanced: Requires Business Analyst, ArcGIS Network Analyst extension