com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools
Class CrossValidation

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools.CrossValidation

All Implemented Interfaces:

GPTool

public class CrossValidation
extends AbstractGPTool

Removes one data location and then predicts the associated data using the data at the rest of the locations. The primary use for this tool is to compare the predicted value to the observed value in order to obtain useful information about some of your model parameters. The Cross Validation tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• When using this tool in Python, the result object contains both a feature class and a , which has the following properties;
  • Count—Total number of samples used.
  • Mean Error—The averaged difference between the measured and the predicted values.
  • Root Mean Square Error—Indicates how closely your model predicts the measured values. The smaller this error, the better.
  • Average Standard Error—The average of the prediction standard errors.
  • Mean Standardized Error—
  • Root Mean Square Standardized Error—This should be close to one if the prediction standard errors are valid. If the root-mean-squared standardized error is greater than one, you are underestimating the variability in your predictions. If the root mean square standardized error is less than one, you are overestimating the variability in your predictions.
  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.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

CrossValidation()
Creates the Cross Validation tool with defaults.

CrossValidation(Object inGeostatLayer)
Creates the Cross Validation tool with the required parameters.

Method Summary

double	getAverageStandard() Returns the Average Standard parameter of this tool (Read only).
int	getCount() Returns the Count parameter of this tool (Read only).
Object	getInGeostatLayer() Returns the Input geostatistical layer parameter of this tool .
double	getMeanError() Returns the Mean Error parameter of this tool (Read only).
double	getMeanStandardized() Returns the Mean Standardized parameter of this tool (Read only).
Object	getOutFeatureClass() Returns the Output point feature class parameter of this tool .
double	getRootMeanSquare() Returns the Root Mean Square parameter of this tool (Read only).
double	getRootMeanSquareStandardized() Returns the Root Mean Square Standardized parameter of this tool (Read only).
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setInGeostatLayer(Object inGeostatLayer) Sets the Input geostatistical layer parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output point feature class parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CrossValidation

public CrossValidation()

Creates the Cross Validation tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

CrossValidation

public CrossValidation(Object inGeostatLayer)

Creates the Cross Validation tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inGeostatLayer - the geostatistical layer to be analyzed.

Method Detail

getInGeostatLayer

public Object getInGeostatLayer()

Returns the Input geostatistical layer parameter of this tool . This parameter is the geostatistical layer to be analyzed. This is a required parameter.

Returns:

the Input geostatistical layer

setInGeostatLayer

public void setInGeostatLayer(Object inGeostatLayer)

Sets the Input geostatistical layer parameter of this tool . This parameter is the geostatistical layer to be analyzed. This is a required parameter.

Parameters:

inGeostatLayer - the geostatistical layer to be analyzed.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output point feature class parameter of this tool . This parameter is stores the cross validation statistics at each location in the geostatistical layer. This is an optional parameter.

Returns:

the Output point feature class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output point feature class parameter of this tool . This parameter is stores the cross validation statistics at each location in the geostatistical layer. This is an optional parameter.

Parameters:

outFeatureClass - stores the cross validation statistics at each location in the geostatistical layer.

getCount

public int getCount()

Returns the Count parameter of this tool (Read only). This is an derived parameter.

Returns:

the Count

getMeanError

public double getMeanError()

Returns the Mean Error parameter of this tool (Read only). This is an derived parameter.

Returns:

the Mean Error

getRootMeanSquare

public double getRootMeanSquare()

Returns the Root Mean Square parameter of this tool (Read only). This is an derived parameter.

Returns:

the Root Mean Square

getAverageStandard

public double getAverageStandard()

Returns the Average Standard parameter of this tool (Read only). This is an derived parameter.

Returns:

the Average Standard

getMeanStandardized

public double getMeanStandardized()

Returns the Mean Standardized parameter of this tool (Read only). This is an derived parameter.

Returns:

the Mean Standardized

getRootMeanSquareStandardized

public double getRootMeanSquareStandardized()

Returns the Root Mean Square Standardized parameter of this tool (Read only). This is an derived parameter.

Returns:

the Root Mean Square Standardized

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias