Add Variable Based Suitability Criteria (Business Analyst)

Available with Business Analyst license.

Summary

Adds criteria based on the values calculated for the input layer using the Enrich Layer tool.

Usage

  • You must be signed in to ArcGIS Online or have Business Analyst Data installed.

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

  • The selected variables are used to enrich the site layer.

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

Parameters

LabelExplanationData Type
Input Suitability Analysis Layer

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

Feature Layer
Variables

The variables from which the suitability criteria will be determined.

String

Derived Output

LabelExplanationData Type
Output Suitability Analysis Layer

The name of the Suitability Analysis layer that will be added to the map.

Feature Layer
Output Criteria Name

The name of the criteria that will be added to the Suitability Analysis layer.

String

arcpy.ba.AddVariableBasedSuitabilityCriteria(in_analysis_layer, variables)
NameExplanationData Type
in_analysis_layer

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

Feature Layer
variables
[variables,...]

The variables from which the suitability criteria will be determined.

String

Derived Output

NameExplanationData Type
out_analysis_layer

The name of the Suitability Analysis layer that will be added to the map.

Feature Layer
out_criteria_name

The name of the criteria that will be added to the Suitability Analysis layer.

String

Code sample

AddVariableBasedSuitabilityCriteria example (Python window)

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

import arcpy
arcpy.ba.AddVariableBasedSuitabilityCriteria("Site Suitability", "wealth.meddi_cy;wealth.mednw_cy")
AddVariableBasedSuitabilityCriteria with Statistical Data Collection variable example (Python window)

The following Python window script demonstrates how to use the AddVariableBasedSuitabilityCriteria tool with Statistical Data Collection variables.

import arcpy
arcpy.ba.AddVariableBasedSuitabilityCriteria("Suitability Analysis", r"c:\users\<User ID>\documents\arcgis\projects\myproject\bayarea_proprietarydata.sdcx/sales_s01_sales;c:\users\<User ID>\documents\arcgis\projects\myproject\bayarea_proprietarydata.sdcx/populationtotals_dpopdenscy")

Licensing information

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

Related topics