Set Model Parameter (Geostatisical Analyst)
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 is either a geostatistical layer or a geostatistical model (XML).
-
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']
- To change the number of lags parameter:
-
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)
Syntax
| Parameter | 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
Change the value of a parameter in a geostatistical model source.
import arcpy
from arcpy import env
env.workspace = "C:/gapyexamples/data"
newParam = arcpy.GASetModelParameter_ga(
"C:/gapyexamples/data/kriging.lyr",
"/model[@name = 'Kriging']/model[@name = 'Variogram']/value[@name = 'Nugget']",
"1", "C:/gapyexamples/output/outModel.xml")
print newParam
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"
# Check out the ArcGIS Geostatistical Analyst extension license
arcpy.CheckOutExtension("GeoStats")
# Execute GASetModelParameter
newParam = arcpy.GASetModelParameter_ga(modelSource, xmlPath, newValue, outModel)
# Show results
print newParam