Get Model Parameter (Geostatistical Analyst)

Available with Geostatistical Analyst license.

Summary

Gets model parameter value from 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.

  • See Set Model Parameter for additional information.

  • An example input model source:

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

    will return "out_param_value" = 0.345;1127.14

  • The returned value can be viewed in the Geoprocessing History item for the run of this tool.

Parameters

LabelExplanationData 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

Derived Output

LabelExplanationData Type
Parameter value

The model parameter value.

String

arcpy.ga.GAGetModelParameter(in_ga_model_source, model_param_xpath)
NameExplanationData 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

Derived Output

NameExplanationData Type
out_param_value

The model parameter value.

String

Code sample

GetModelParameter example 1 (Python window)

Extract parameter values from a geostatistical model source.

import arcpy
arcpy.env.workspace = "C:/gapyexamples/data"
outParam = arcpy.GAGetModelParameter_ga(
    "C:/gapyexamples/data/kriging.lyr",
    "/model[@name = 'Kriging']/model[@name = 'Variogram']/value[@name = 'Nugget']")
print(outParam)
GetModelParameter example 2 (stand-alone script)

Extract parameter values from a geostatistical model source.

# Name: GAGetModelParameter_Example_02.py
# Description: Gets model parameter value from 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']"

# Execute GAGetModelParameter
outParam = arcpy.GAGetModelParameter_ga(modelSource, xmlPath)

# Show results
print(outParam)

Environments

Licensing information

  • Basic: Requires Geostatistical Analyst
  • Standard: Requires Geostatistical Analyst
  • Advanced: Requires Geostatistical Analyst

Related topics