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 raster surface from points using kriging. The Kriging tool is contained in the 3D Analyst Tools tool box.

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.
• Low values within the optoinal 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 Universal kriging types 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.The various interpolation tools may handle this data condition differently. For example, in some cases the first coincident point encountered is used for the calculation; in other cases the last point encountered is used. 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. The tool in the Spatial Statistics toolbox is useful for identifying any coincident points in your data.

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 - the input point features containing the z-values to be interpolated into a surface raster.

zField - the field that holds a height or magnitude value for each point. this can be a numeric field or the Shape field if the input point features contains z-values.

outSurfaceRaster - null

semiVariogramProps - the KrigingModel class defines which kriging model is to be used. there are two types of kriging methods. The KrigingModelOrdinary method has five types of semivariogram available. The KrigingModelUniversal method has two types of semivariogram available.

Method Detail

getInPointFeatures

public Object getInPointFeatures()

Returns the Input point features parameter of this tool . This parameter is 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 the input point features containing the z-values to be interpolated into a surface raster. This is a required parameter.

Parameters:

inPointFeatures - 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 the field that holds a height or magnitude value for each point. this can be a numeric field or the Shape field if the input 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 the field that holds a height or magnitude value for each point. this can be a numeric field or the Shape field if the input point features contains z-values. This is a required parameter.

Parameters:

zField - the field that holds a height or magnitude value for each point. this can be a numeric field or the Shape field if the input point features contains z-values.

getOutSurfaceRaster

public Object getOutSurfaceRaster()

Returns the Output surface raster parameter of this tool . 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 is a required parameter.

Parameters:

outSurfaceRaster - null

getSemiVariogramProps

public Object getSemiVariogramProps()

Returns the Semivariogram properties parameter of this tool . This parameter is the KrigingModel class defines which kriging model is to be used. there are two types of kriging methods. The KrigingModelOrdinary method has five types of semivariogram available. The KrigingModelUniversal method has two types of semivariogram available. 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 the KrigingModel class defines which kriging model is to be used. there are two types of kriging methods. The KrigingModelOrdinary method has five types of semivariogram available. The KrigingModelUniversal method has two types of semivariogram available. This is a required parameter.

Parameters:

semiVariogramProps - the KrigingModel class defines which kriging model is to be used. there are two types of kriging methods. The KrigingModelOrdinary method has five types of semivariogram available. The KrigingModelUniversal method has two types of semivariogram available.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is the cell size at which the output raster will be created. 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 the input 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 the cell size at which the output raster will be created. 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 the input point features, in the input spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - the cell size at which the output raster will be created. 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 the input 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 defines which of the input points will be used to interpolate the value for each cell in the output raster. there are two ways to specify the points, Variable and Fixed. variable uses a variable search radius in order to find a specified number of input sample points for the interpolation. Fixed uses a specified fixed distance within which all input points will be used. Variable is the default. the syntax for these parameters are: 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 defines which of the input points will be used to interpolate the value for each cell in the output raster. there are two ways to specify the points, Variable and Fixed. variable uses a variable search radius in order to find a specified number of input sample points for the interpolation. Fixed uses a specified fixed distance within which all input points will be used. Variable is the default. the syntax for these parameters are: This is an optional parameter.

Parameters:

searchRadius - defines which of the input points will be used to interpolate the value for each cell in the output raster. there are two ways to specify the points, Variable and Fixed. variable uses a variable search radius in order to find a specified number of input sample points for the interpolation. Fixed uses a specified fixed distance within which all input points will be used. Variable is the default. the syntax for these parameters are:

• Variable, number_of points, maximum_distance

getOutVariancePredictionRaster

public Object getOutVariancePredictionRaster()

Returns the Output variance of prediction raster parameter of this tool . This parameter is 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 optional output raster where each cell contains the predicted semi-variance values for that location. This is an optional parameter.

Parameters:

outVariancePredictionRaster - 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