Set Model Parameter (Geostatistical Analyst Tools)

Summary

Sets parameter values in an existing geostatistical model source.

Usage

This tool is generally used in a model or in scripting.
The geostatistical model source must be a geostatistical layer.
The examples below can be used in the Parameter XML Path to specify which parameter will be set to a new value.
- To change the number of lags parameter:
  
  /model[@name = 'Kriging']/model[@name = 'Variogram']/value[@name = 'NumberOfLags']
- To change the weight parameter for LPI:
  
  /model[@name = 'LPI']/value[@name = 'Weight']
- To specify whether the nugget should be recalculated in Kriging:
  
  /model[@name = "Kriging"]/model[@name = "Variogram"]/value[@name = "Nugget"]/@auto
  
  Then specify a true or false value (true implies that a new nugget value will be calculated when the XML file is used).
- To specify whether a new range should be calculated:
  
  /model[@name = 'Kriging']/model[@name = 'Variogram']/model[@name = 'VariogramModel']/value[@name = 'Range']/@auto
  
  Then specify a true or false value (true implies that a new range value will be calculated when the XML file is used).
- To specify a new nugget value:
  
  /model[@name = 'Kriging']/model[@name = 'Variogram']/value[@name = 'Nugget']

The XPath code snippet below sets multiple parameters via a single call to the tool.

params = "/model[@name = 'Kriging']/model[@name = 'Variogram']/value[@name = 'Nugget']/@auto;\

          /model[@name = 'Kriging']/model[@name = 'Variogram']/model[@name = 'VariogramModel']/value[@name = 'Range'];\

          /model[@name = 'Kriging']/model[@name = 'Variogram']/model[@name = 'VariogramModel']/value[@name = 'Sill']"

vals = "true;5.5;777"

gp.GASetModelParameter_ga(inXMLFile, params, vals, outXMLFile)

Label	Explanation	Data type
Input geostatistical model source	The geostatistical model source to be analyzed.	File; Geostatistical Layer
Parameter XML Path	XML path to the required model parameter.	String
Parameter value	Value for the parameter defined by the XML path.	String
Output model	Geostatistical model created with the parameter value defined in the XML path.	File

arcpy.ga.GASetModelParameter(in_ga_model_source, model_param_xpath, in_param_value, out_ga_model)

Name	Explanation	Data type
in_ga_model_source	The geostatistical model source to be analyzed.	File; Geostatistical Layer
model_param_xpath	XML path to the required model parameter.	String
in_param_value	Value for the parameter defined by the XML path.	String
out_ga_model	Geostatistical model created with the parameter value defined in the XML path.	File

Code sample

SetModelParameter example 1 (Python window)

Change the value of a parameter in a geostatistical model source.

import arcpy
from arcpy import env
env.workspace = "C:/gapyexamples/data"
newParam = arcpy.ga.GASetModelParameter(
    "C:/gapyexamples/data/kriging.lyr",
    "/model[@name = 'Kriging']/model[@name = 'Variogram']/value[@name = 'Nugget']",
    "1", "C:/gapyexamples/output/outModel.xml")
print(newParam)

SetModelParameter example 2 (stand-alone script)

Change the value of a parameter in a geostatistical model source.

# Name: GASetModelParameter_Example_02.py
# Description: Sets parameter value in an existing geostatistical model source.
# Requirements: Geostatistical Analyst extension

# Import system modules
import arcpy

# Set environment settings
arcpy.env.workspace = "C:/gapyexamples/data"

# Set local variables
modelSource = "C:/gapyexamples/data/kriging.lyr"
xmlPath = "/model[@name = 'Kriging']/model[@name = 'Variogram']/value[@name = 'Nugget']"
newValue = 1
outModel = "C:/gapyexamples/output/outModel.xml"

# Run GASetModelParameter
newParam = arcpy.ga.GASetModelParameter(modelSource, xmlPath, newValue, outModel)

# Show results
print(newParam)

Environments

Current Workspace, Scratch Workspace

Licensing information