Set Criteria Properties (Business Analyst)—ArcGIS Pro

Available with Business Analyst license.

Summary

Define parameters for criteria.

Usage

The analysis layer can be created by the Make Suitability Analysis Layer tool.
All of the criteria weights criteria should total 100 percent.
The influence of the criteria can be positive or inverse.
When Ideal is selected, Ideal Value must have an input.

Syntax

arcpy.ba.SetCriteriaProperties(in_analysis_layer, criteria_properties)

Parameter	Explanation	Data Type
in_analysis_layer	The Suitability Analysis layer that will be used in the analysis.	Feature Layer
criteria_properties [[criterion, title, weight, influence, ideal_value, minimum_value, maximum_value, enabled],...]	The input features that will be used to set up your criteria properties. criterion—The field, point, or variable that will be used to calculate your suitability score. title—The name of your criteria. weight—The influence a criteria value has on the overall suitability score. The number must be greater than or equal to 0. influence—Can be positive, inverse, or ideal. An example of a positive influence is as follows: You want a site to score higher if it has a greater number of households holding graduate or professional degrees. An example of an inverse influence is as follows: A lower median home value is more desirable as it is indicative of greater home affordability. An example of an ideal influence would be a search for areas within a range of values. POSITIVE—The higher the criteria value, the higher the suitability score. INVERSE—The lower the criteria value, the higher the suitability score. IDEAL—The closer to the ideal value, the higher the score. ideal_value—The closer the criteria value is to the ideal_value, the higher the suitability score. minimum_value—A numeric value that sets a hard limit for the criteria lower bound. maximum_value—A numeric value that sets a hard limit for the criteria upper bound. enabled—Check to include the criteria in the final suitability score.	Value Table

Parameter

Explanation

Data Type

in_analysis_layer

The Suitability Analysis layer that will be used in the analysis.

Feature Layer

criteria_properties

[[criterion, title, weight, influence, ideal_value, minimum_value, maximum_value, enabled],...]

The input features that will be used to set up your criteria properties.

criterion—The field, point, or variable that will be used to calculate your suitability score.
title—The name of your criteria.
weight—The influence a criteria value has on the overall suitability score. The number must be greater than or equal to 0.
influence—Can be positive, inverse, or ideal. An example of a positive influence is as follows: You want a site to score higher if it has a greater number of households holding graduate or professional degrees. An example of an inverse influence is as follows: A lower median home value is more desirable as it is indicative of greater home affordability. An example of an ideal influence would be a search for areas within a range of values.
- POSITIVE—The higher the criteria value, the higher the suitability score.
- INVERSE—The lower the criteria value, the higher the suitability score.
- IDEAL—The closer to the ideal value, the higher the score.
ideal_value—The closer the criteria value is to the ideal_value, the higher the suitability score.
minimum_value—A numeric value that sets a hard limit for the criteria lower bound.
maximum_value—A numeric value that sets a hard limit for the criteria upper bound.
enabled—Check to include the criteria in the final suitability score.

Value Table

Derived Output

Name	Explanation	Data Type
out_analysis_layer	The name of the Suitability Analysis layer that will be added to the map.	Feature Layer

Code sample

SetCriteriaProperties example (Python window)

The following Python window script demonstrates how to use the SetCriteriaProperties tool.

import arcpy
arcpy.ba.SetCriteriaProperties("Site Suitability001", "wealth_meddi_cy 'Criterion for wealth.meddi_cy variable' 1 # # POSITIVE # true;wealth_mednw_cy 'Criterion for wealth.mednw_cy variable' 1 # # INVERSE # true")

Environments

Current Workspace

Licensing information

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