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 given point layer.

Usage

• The analysis layer can be created by the Make Suitability Analysis Layer tool.

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

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

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

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

Syntax

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})

Parameter	Explanation	Data Type
in_analysis_layer	The Suitability Analysis layer that will be used in the analysis.	Feature Layer
site_layer_id_field	A field containing unique values for each record within the Suitability Analysis layer.	Field
in_point_features	The layer containing point locations to be added as criteria based on spatial relationship to the Suitability Analysis layer.	Feature Layer
criteria_type	Defines the type of spatial relationship to be used as criteria. COUNT —A count of points that fall within each Suitability Analysis layer polygon. This is the default. WEIGHT —Calculates field-weighted criteria of points that fall within each Suitability Analysis polygon based on the user-selected statistical type. MINIMAL_DISTANCE —Adds distance from the closest point to each of the Suitability Analysis layer centroids as criteria.	String
distance_type (Optional)	Defines how minimal distance is calculated based on method of travel.	String
units (Optional)	Defines the type of distance measuring units to 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 existing within the in_site_centers_features parameter that uniquely identifies each record.	Field
weight_field	Numeric fields that exist within a point layer that can be selected for weighting.	Field
statistics_type (Optional)	The type of statistical operation to be applied to the weighted field. SUM —Calculates the total of the field values in each point feature. AVE —Determines the average field value in each point feature. STD_DEV —Calculates the standard deviation of the field values in each point feature. MIN —Determines the smallest field value in each point feature. MAX —Determines the largest field value in 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
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 tool.

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

Licensing information

• Basic: Requires Business Analyst
• Standard: Requires Business Analyst
• Advanced: Requires Business Analyst