CrossValidationResult (arcpy)

Summary

The CrossValidationResult class is returned by the Cross Validation tool and contains access to the cross-validation results that can be generated for any geostatistical layer.

Discussion

The CrossValidationResult class is similar to Result class except for the additional read-only properties that it contains. For detailed help, see the Cross Validation tool help.

Only the mean and root mean square error results are available for IDW, global polynomial interpolation, radial basis functions, diffusion interpolation with barriers, and kernel interpolation with barriers.

Properties

Property	Explanation	Data Type
averageStandard (Read Only)	The average of the prediction standard errors.	Double
count (Read Only)	The number of input samples.	Long
inputCount (Read Only)	Returns the number of inputs.	Integer
maxSeverity (Read Only)	Returns the maximum severity of the messages. 0 —If the tool produced only informative messages. 1 — If the tool produced a warning message, but no error messages. 2 — If the tool produced an error message.	Integer
meanError (Read Only)	The averaged difference between the measured and the predicted values.	Double
meanStandardized (Read Only)	Mean standardized error.	Double
messageCount (Read Only)	Returns the number of messages.	Integer
outputCount (Read Only)	Returns the number of outputs.	Integer
resultID (Read Only)	Gets the job ID. If the tool is not a geoprocessing service, the resultID will be "".	String
rootMeanSquare (Read Only)	The root mean square error.	Double
rootMeanSquareStandardized (Read Only)	The root mean square standardized error should be close to 1 if the prediction standard errors are valid. If the root mean square standardized error is greater than 1, you are underestimating the variability in your predictions. If the root mean square standardized error is less than 1, you are overestimating the variability in your predictions.	Double
status (Read Only)	Gets the job status. 0 —New 1 —Submitted 2 —Waiting 3 —Executing 4 —Succeeded 5 —Failed 6 —Timed out 7 —Cancelling 8 —Cancelled 9 —Deleting 10 —Deleted	Integer

Method Overview

Method	Explanation
cancel ()	Cancels an associated job
getInput (index)	Returns a given input, either as a recordset or string.
getMapImageURL ({parameter_list}, {height}, {width}, {resolution})	Gets a map service image for a given output, if one exists.
getMessage (index)	Returns a specific message.
getMessages ({severity})	Returns messages.
getOutput (index)	Returns a given output, either as a recordset or a string. If the output of the tool, such as MakeFeatureLayer is a layer, getOutput will return a Layer object.
getSeverity (index)	Returns the severity of a specific message.

Methods

cancel ()

getInput (index)

Parameter	Explanation	Data Type
index	The index position of the input.	Integer

Return Value

Data Type	Explanation
Object	The input, either as a recordset or string.

getMapImageURL ({parameter_list}, {height}, {width}, {resolution})

Parameter	Explanation	Data Type
parameter_list	Parameter(s) on which the map service image will be based.	Integer
height	The height of the image.	Double
width	The width of the image.	Double
resolution	The resolution of the image.	Double

Return Value

Data Type	Explanation
String	The URL of the map image.

getMessage (index)

Parameter	Explanation	Data Type
index	The index position of the message.	Integer

Return Value

Data Type	Explanation
String	The geoprocessing message.

getMessages ({severity})

Parameter	Explanation	Data Type
severity	The type of messages to be returned: 0=message, 1=warning, 2=error. Not specifying a value returns all message types. 0 —informational message 1 —warning message 2 —error message (The default value is 0)	Integer

Return Value

Data Type	Explanation
String	The geoprocessing messages.

getOutput (index)

Parameter	Explanation	Data Type
index	The index position of the outputs.	Integer

Return Value

Data Type	Explanation
Object	The output, either as a recordset or a string. If the output of the tool, such as MakeFeatureLayer is a layer, getOutput will return a Layer object. Result outputs can also be accessed by index, so result.getOutput(0) and result[0] are equivalent.

getSeverity (index)

Parameter	Explanation	Data Type
index	The message index position.	Integer

Return Value

Data Type	Explanation
Integer	The severity of the specific message. 0 —informational message 1 —warning message 2 —error message

Code Sample

CrossValidation (Python window)

Perform cross-validation on an input geostatistical layer.

import arcpy
arcpy.env.workspace = "C:/gapyexamples/data"
cvResult = arcpy.CrossValidation_ga("C:/gapyexamples/data/kriging.lyr")
print "Root Mean Square error = " + str(cvResult.rootMeanSquare)

CrossValidation (stand-alone script)

Perform cross-validation on an input geostatistical layer.

# Name: CrossValidation_Example_02.py
# Description: Perform cross validation on an input geostatistical layer.
# Requirements: Geostatistical Analyst Extension

# Import system modules
import arcpy

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

# Set local variables
inLayer = "C:/gapyexamples/data/kriging.lyr"

# Check out the ArcGIS Geostatistical Analyst extension license
arcpy.CheckOutExtension("GeoStats")

# Execute CrossValidation
cvResult = arcpy.CrossValidation_ga(inLayer)
print "Root Mean Square error = " + str(cvResult.rootMeanSquare)