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

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

All Implemented Interfaces:

GPTool

public class KernelInterpolationWithBarriers
extends AbstractGPTool

A moving window predictor that uses the shortest distance between points so that points on either side of the line barriers are connected. The Kernel Interpolation With Barriers tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• The Absolute feature barrier employs a “non Euclidean” distance approach rather than a “line of sight” approach. The “line of sight” approach requires that a straight line between the measured location and the location where the prediction is required do not intersect the barrier feature. If the distance around the barrier is within the searching neighborhood specifications, then it will be considered in this “non Euclidean” distance approach.
• The processing time is dependent on the complexity of the barrier feature classes geometry. Tools in the can be used to create a new feature class by smoothing or deleting some of these features.

Field Summary

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

vals

Constructor Summary

KernelInterpolationWithBarriers()
Creates the Kernel Interpolation With Barriers tool with defaults.

KernelInterpolationWithBarriers(java.lang.Object inFeatures, java.lang.Object zField)
Creates the Kernel Interpolation With Barriers tool with the required parameters.

Method Summary

double	getBandwidth() Returns the Bandwidth parameter of this tool .
java.lang.Object	getCellSize() Returns the Output cell size parameter of this tool .
java.lang.Object	getInBarrierFeatures() Returns the Input absolute barrier features parameter of this tool .
java.lang.Object	getInFeatures() Returns the Input feature class parameter of this tool .
java.lang.String	getKernelFunction() Returns the Kernel function parameter of this tool .
java.lang.Object	getOutLayer() Returns the Output geostatistical layer parameter of this tool .
java.lang.Object	getOutRaster() Returns the Output raster parameter of this tool .
int	getPower() Returns the Order of polynomial parameter of this tool .
double	getRidge() Returns the Ridge parameter parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
java.lang.Object	getZField() Returns the Z value field parameter of this tool .
void	setBandwidth(double bandwidth) Sets the Bandwidth parameter of this tool .
void	setCellSize(java.lang.Object cellSize) Sets the Output cell size parameter of this tool .
void	setInBarrierFeatures(java.lang.Object inBarrierFeatures) Sets the Input absolute barrier features parameter of this tool .
void	setInFeatures(java.lang.Object inFeatures) Sets the Input feature class parameter of this tool .
void	setKernelFunction(java.lang.String kernelFunction) Sets the Kernel function parameter of this tool .
void	setOutLayer(java.lang.Object outLayer) Sets the Output geostatistical layer parameter of this tool .
void	setOutRaster(java.lang.Object outRaster) Sets the Output raster parameter of this tool .
void	setPower(int power) Sets the Order of polynomial parameter of this tool .
void	setRidge(double ridge) Sets the Ridge parameter parameter of this tool .
void	setZField(java.lang.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

KernelInterpolationWithBarriers

public KernelInterpolationWithBarriers()

Creates the Kernel Interpolation With Barriers tool with defaults.

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

KernelInterpolationWithBarriers

public KernelInterpolationWithBarriers(java.lang.Object inFeatures,
                                       java.lang.Object zField)

Creates the Kernel Interpolation With Barriers 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:

inFeatures - the input point features containing the z-values to be interpolated.

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

Method Detail

getInFeatures

public java.lang.Object getInFeatures()

Returns the Input feature class parameter of this tool . This parameter is the input point features containing the z-values to be interpolated. This is a required parameter.

Returns:

the Input feature class

setInFeatures

public void setInFeatures(java.lang.Object inFeatures)

Sets the Input feature class parameter of this tool . This parameter is the input point features containing the z-values to be interpolated. This is a required parameter.

Parameters:

inFeatures - the input point features containing the z-values to be interpolated.

getZField

public java.lang.Object getZField()

Returns the Z value field parameter of this tool . This parameter is field that holds a height or magnitude value for each point. This can be a numeric field or the Shape field if the input features contains z-values or m-values. This is a required parameter.

Returns:

the Z value field

setZField

public void setZField(java.lang.Object zField)

Sets the Z value field parameter of this tool . This parameter is field that holds a height or magnitude value for each point. This can be a numeric field or the Shape field if the input features contains z-values or m-values. This is a required parameter.

Parameters:

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

getOutLayer

public java.lang.Object getOutLayer()

Returns the Output geostatistical layer parameter of this tool . This parameter is the geostatistical layer produced. This layer is required output only if no output raster is requested. This is an optional parameter.

Returns:

the Output geostatistical layer

setOutLayer

public void setOutLayer(java.lang.Object outLayer)

Sets the Output geostatistical layer parameter of this tool . This parameter is the geostatistical layer produced. This layer is required output only if no output raster is requested. This is an optional parameter.

Parameters:

outLayer - the geostatistical layer produced. This layer is required output only if no output raster is requested.

getOutRaster

public java.lang.Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. This raster is required output only if no output geostatistical layer is requested. This is an optional parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(java.lang.Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output raster. This raster is required output only if no output geostatistical layer is requested. This is an optional parameter.

Parameters:

outRaster - the output raster. This raster is required output only if no output geostatistical layer is requested.

getCellSize

public java.lang.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 value can be explicitly set under Raster Analysis from the Environment Settings. If not set, 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(java.lang.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 value can be explicitly set under Raster Analysis from the Environment Settings. If not set, 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 value can be explicitly set under Raster Analysis from the Environment Settings. If not set, 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.

getInBarrierFeatures

public java.lang.Object getInBarrierFeatures()

Returns the Input absolute barrier features parameter of this tool . This parameter is absolute barrier features using non Euclidean distances rather than "line of sight" distances. This is an optional parameter.

Returns:

the Input absolute barrier features

setInBarrierFeatures

public void setInBarrierFeatures(java.lang.Object inBarrierFeatures)

Sets the Input absolute barrier features parameter of this tool . This parameter is absolute barrier features using non Euclidean distances rather than "line of sight" distances. This is an optional parameter.

Parameters:

inBarrierFeatures - absolute barrier features using non Euclidean distances rather than "line of sight" distances.

getKernelFunction

public java.lang.String getKernelFunction()

Returns the Kernel function parameter of this tool . This parameter is the kernel function used in the simulation. This is an optional parameter.

Returns:

the Kernel function

setKernelFunction

public void setKernelFunction(java.lang.String kernelFunction)

Sets the Kernel function parameter of this tool . This parameter is the kernel function used in the simulation. This is an optional parameter.

Parameters:

kernelFunction - the kernel function used in the simulation.

getBandwidth

public double getBandwidth()

Returns the Bandwidth parameter of this tool . This parameter is used to specify the maximum distance at which data points are used for prediction. With increasing bandwidth, prediction bias increases and prediction variance decreases. This is an optional parameter.

Returns:

the Bandwidth

setBandwidth

public void setBandwidth(double bandwidth)

Sets the Bandwidth parameter of this tool . This parameter is used to specify the maximum distance at which data points are used for prediction. With increasing bandwidth, prediction bias increases and prediction variance decreases. This is an optional parameter.

Parameters:

bandwidth - used to specify the maximum distance at which data points are used for prediction. With increasing bandwidth, prediction bias increases and prediction variance decreases.

getPower

public int getPower()

Returns the Order of polynomial parameter of this tool . This parameter is sets the order of the polynomial This is an optional parameter.

Returns:

the Order of polynomial

setPower

public void setPower(int power)

Sets the Order of polynomial parameter of this tool . This parameter is sets the order of the polynomial This is an optional parameter.

Parameters:

power - sets the order of the polynomial

getRidge

public double getRidge()

Returns the Ridge parameter parameter of this tool . This parameter is used for the numerical stabilization of the solution of the system of linear equations. It does not influence predictions in the case of regularly distributed data without barriers. Predictions for areas in which the data are located near the feature barrier or isolated by the barriers can be unstable and tend to require relatively large ridge parameter values. This is an optional parameter.

Returns:

the Ridge parameter

setRidge

public void setRidge(double ridge)

Sets the Ridge parameter parameter of this tool . This parameter is used for the numerical stabilization of the solution of the system of linear equations. It does not influence predictions in the case of regularly distributed data without barriers. Predictions for areas in which the data are located near the feature barrier or isolated by the barriers can be unstable and tend to require relatively large ridge parameter values. This is an optional parameter.

Parameters:

ridge - used for the numerical stabilization of the solution of the system of linear equations. It does not influence predictions in the case of regularly distributed data without barriers. Predictions for areas in which the data are located near the feature barrier or isolated by the barriers can be unstable and tend to require relatively large ridge parameter values.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias