com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class Kriging

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.Kriging

All Implemented Interfaces:

GPTool

public class Kriging
extends AbstractGPTool

Interpolates a surface from points using kriging. The Kriging tool is contained in the 3D Analyst Tools tool box.
Learn more about how Kriging works

Software restrictions: none

Usage tips:

• Kriging is a processor-intensive process. The speed of execution is dependent on the number of points in the input dataset and the size of the search window.
• The Semivariogram Properties dialog box has several models to choose from. When the Kriging method is set to Ordinary, the available models are Spherical, Circular, Exponential, Gaussian, and Linear. When the Kriging method is set to Universal, the available models are Linear with linear drift and Linear with quadratic drift.
• The Universal Kriging types (Linear with linear drift and Linear with quadratic drift) assume that there is a structural component present and that the local trend varies from one location to another.
• The advanced parameters allow control of the semivariogram used for kriging. A default value for lag size is initially set to the default output cell size. For Major range, Partial sill, and Nugget, a default value will be calculated internally if nothing is specified.
• The optional output variance of prediction raster contains the kriging variance at each output raster cell. Assuming the kriging errors are normally distributed, there is a 95.5 percent probability that the actual z-value at the cell is the predicted raster value, plus or minus two times the square root of the value in the prediction raster.
• Some input datasets may have several points with the same X,Y coordinates. If the values of the points at the common location are the same, they are considered duplicates and have no affect on the output. If the values are different, they are considered 'coincident' points. Interpolation functions may handle this data condition differently, in some cases using the first coincident point encountered for the calculation, or sometimes the last. This may cause some locations in the output raster to have different values than what you might expect. The solution is to prepare your data by removing these coincident points.
• Low values within the output variance of prediction raster indicate a high degree of confidence in the predicted value. High values may indicate a need for more data points.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

Kriging()
Creates the Kriging tool with defaults.

Kriging(Object inPointFeatures, Object zField, Object outSurfaceRaster, Object semiVariogramProps)
Creates the Kriging tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getInPointFeatures() Returns the Input point features parameter of this tool .
Object	getOutSurfaceRaster() Returns the Output surface raster parameter of this tool .
Object	getOutVariancePredictionRaster() Returns the Output variance of prediction raster parameter of this tool .
Object	getSearchRadius() Returns the Search radius parameter of this tool .
Object	getSemiVariogramProps() Returns the Semivariogram properties parameter of this tool .
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.
Object	getZField() Returns the Z value field parameter of this tool .
void	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setInPointFeatures(Object inPointFeatures) Sets the Input point features parameter of this tool .
void	setOutSurfaceRaster(Object outSurfaceRaster) Sets the Output surface raster parameter of this tool .
void	setOutVariancePredictionRaster(Object outVariancePredictionRaster) Sets the Output variance of prediction raster parameter of this tool .
void	setSearchRadius(Object searchRadius) Sets the Search radius parameter of this tool .
void	setSemiVariogramProps(Object semiVariogramProps) Sets the Semivariogram properties parameter of this tool .
void	setZField(Object zField) Sets the Z value field 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

Kriging

public Kriging()

Creates the Kriging tool with defaults.

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

Kriging

public Kriging(Object inPointFeatures,
               Object zField,
               Object outSurfaceRaster,
               Object semiVariogramProps)

Creates the Kriging 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:

inPointFeatures - Composite Geodataset, the input point features containing the z-values to be interpolated into a surface raster.

zField - Field, this can be a numeric field or the Shape field if the in_point_features contains z-values.

outSurfaceRaster - Raster Dataset, the output raster surface to be created.

semiVariogramProps - SemiVariogram, semivariogram model to be used.

Method Detail

getInPointFeatures

public Object getInPointFeatures()

Returns the Input point features parameter of this tool . This parameter is Composite Geodataset, the input point features containing the z-values to be interpolated into a surface raster. This is a required parameter.

Returns:

the Input point features

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)

Sets the Input point features parameter of this tool . This parameter is Composite Geodataset, the input point features containing the z-values to be interpolated into a surface raster. This is a required parameter.

Parameters:

inPointFeatures - Composite Geodataset, the input point features containing the z-values to be interpolated into a surface raster.

getZField

public Object getZField()

Returns the Z value field parameter of this tool . This parameter is Field, this can be a numeric field or the Shape field if the in_point_features contains z-values. This is a required parameter.

Returns:

the Z value field

setZField

public void setZField(Object zField)

Sets the Z value field parameter of this tool . This parameter is Field, this can be a numeric field or the Shape field if the in_point_features contains z-values. This is a required parameter.

Parameters:

zField - Field, this can be a numeric field or the Shape field if the in_point_features contains z-values.

getOutSurfaceRaster

public Object getOutSurfaceRaster()

Returns the Output surface raster parameter of this tool . This parameter is Raster Dataset, the output raster surface to be created. This is a required parameter.

Returns:

the Output surface raster

setOutSurfaceRaster

public void setOutSurfaceRaster(Object outSurfaceRaster)

Sets the Output surface raster parameter of this tool . This parameter is Raster Dataset, the output raster surface to be created. This is a required parameter.

Parameters:

outSurfaceRaster - Raster Dataset, the output raster surface to be created.

getSemiVariogramProps

public Object getSemiVariogramProps()

Returns the Semivariogram properties parameter of this tool . This parameter is SemiVariogram, semivariogram model to be used. This is a required parameter.

Returns:

the Semivariogram properties

setSemiVariogramProps

public void setSemiVariogramProps(Object semiVariogramProps)

Sets the Semivariogram properties parameter of this tool . This parameter is SemiVariogram, semivariogram model to be used. This is a required parameter.

Parameters:

semiVariogramProps - SemiVariogram, semivariogram model to be used.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is Analysis cell size, this will be the value in the environment if it is explicitly set. Otherwise, it is the shorter of the width or the height of the extent of in_point_features in the input spatial reference, divided by 250. This is an optional parameter.

Returns:

the Output cell size

setCellSize

public void setCellSize(Object cellSize)

Sets the Output cell size parameter of this tool . This parameter is Analysis cell size, this will be the value in the environment if it is explicitly set. Otherwise, it is the shorter of the width or the height of the extent of in_point_features in the input spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - Analysis cell size, this will be the value in the environment if it is explicitly set. Otherwise, it is the shorter of the width or the height of the extent of in_point_features in the input spatial reference, divided by 250.

getSearchRadius

public Object getSearchRadius()

Returns the Search radius parameter of this tool . This parameter is Radius, {distance} The distance, in map units, specifying that all input sample points within the specified radius will be used to perform interpolation. The default radius is five times the cell size of the output raster. {minimum_number_of_points} An integer defining the minimum number of points to be used for interpolation. If the required number of points is not found within the specified radius, the search radius will be increased until the specified minimum number of points is found. The default is zero. This is an optional parameter.

Returns:

the Search radius

setSearchRadius

public void setSearchRadius(Object searchRadius)

Sets the Search radius parameter of this tool . This parameter is Radius, {distance} The distance, in map units, specifying that all input sample points within the specified radius will be used to perform interpolation. The default radius is five times the cell size of the output raster. {minimum_number_of_points} An integer defining the minimum number of points to be used for interpolation. If the required number of points is not found within the specified radius, the search radius will be increased until the specified minimum number of points is found. The default is zero. This is an optional parameter.

Parameters:

searchRadius - Radius, {distance} The distance, in map units, specifying that all input sample points within the specified radius will be used to perform interpolation. The default radius is five times the cell size of the output raster. {minimum_number_of_points} An integer defining the minimum number of points to be used for interpolation. If the required number of points is not found within the specified radius, the search radius will be increased until the specified minimum number of points is found. The default is zero.

getOutVariancePredictionRaster

public Object getOutVariancePredictionRaster()

Returns the Output variance of prediction raster parameter of this tool . This parameter is Raster Dataset, optional output raster where each cell contains the predicted semi-variance values for that location. This is an optional parameter.

Returns:

the Output variance of prediction raster

setOutVariancePredictionRaster

public void setOutVariancePredictionRaster(Object outVariancePredictionRaster)

Sets the Output variance of prediction raster parameter of this tool . This parameter is Raster Dataset, optional output raster where each cell contains the predicted semi-variance values for that location. This is an optional parameter.

Parameters:

outVariancePredictionRaster - Raster Dataset, optional output raster where each cell contains the predicted semi-variance values for that location.

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