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

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

All Implemented Interfaces:

GPTool

public class DiffusionInterpolationWithBarriers
extends AbstractGPTool

Uses a kernel that is based upon the heat equation and allows one to use a combination of raster and feature datasets to act as a barrier. The Diffusion 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.
• For the Input Additive Raster Barrier parameter, the values must be greater than or equal to 1. A value of 1 implies that the barrier is impervious, in other words, an absolute barrier.
• The Input Cumulative Raster Barrier parameter should have values that are of the same order as that of the x,y coordinates. If neighboring cells have the same values then it implies that there is no barrier at that location.
• Input Flow Raster Barrier should have values that are of the same order as that of the x,y coordinates. If the neighboring cells have the same values then it implies that there is no barrier at that location. Also, if you go from a high to a low value then it implies that there is no barrier.

Field Summary

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

vals

Constructor Summary

DiffusionInterpolationWithBarriers()
Creates the Diffusion Interpolation With Barriers tool with defaults.

DiffusionInterpolationWithBarriers(Object inFeatures, Object zField)
Creates the Diffusion Interpolation With Barriers tool with the required parameters.

Method Summary

double	getBandwidth() Returns the Bandwidth parameter of this tool .
Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getInAdditiveBarrierRaster() Returns the Input additive barrier raster parameter of this tool .
Object	getInBarrierFeatures() Returns the Input absolute barrier features parameter of this tool .
Object	getInCumulativeBarrierRaster() Returns the Input cumulative barrier raster parameter of this tool .
Object	getInFeatures() Returns the Input feature class parameter of this tool .
Object	getInFlowBarrierRaster() Returns the Input flow barrier raster parameter of this tool .
int	getNumberIterations() Returns the Number of iterations parameter of this tool .
Object	getOutLayer() Returns the Output geostatistical layer parameter of this tool .
Object	getOutRaster() Returns the Output raster 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	getWeightField() Returns the Weight field parameter of this tool .
Object	getZField() Returns the Z value field parameter of this tool .
void	setBandwidth(double bandwidth) Sets the Bandwidth parameter of this tool .
void	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setInAdditiveBarrierRaster(Object inAdditiveBarrierRaster) Sets the Input additive barrier raster parameter of this tool .
void	setInBarrierFeatures(Object inBarrierFeatures) Sets the Input absolute barrier features parameter of this tool .
void	setInCumulativeBarrierRaster(Object inCumulativeBarrierRaster) Sets the Input cumulative barrier raster parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input feature class parameter of this tool .
void	setInFlowBarrierRaster(Object inFlowBarrierRaster) Sets the Input flow barrier raster parameter of this tool .
void	setNumberIterations(int numberIterations) Sets the Number of iterations parameter of this tool .
void	setOutLayer(Object outLayer) Sets the Output geostatistical layer parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setWeightField(Object weightField) Sets the Weight field 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

DiffusionInterpolationWithBarriers

public DiffusionInterpolationWithBarriers()

Creates the Diffusion Interpolation With Barriers tool with defaults.

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

DiffusionInterpolationWithBarriers

public DiffusionInterpolationWithBarriers(Object inFeatures,
                                          Object zField)

Creates the Diffusion 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 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(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 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(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 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(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 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(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 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(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 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(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.

getInAdditiveBarrierRaster

public Object getInAdditiveBarrierRaster()

Returns the Input additive barrier raster parameter of this tool . This parameter is the travel distance from one raster cell to the next based on this formula: (average cost value in the neighboring cells) x (distance between cell centers) This is an optional parameter.

Returns:

the Input additive barrier raster

setInAdditiveBarrierRaster

public void setInAdditiveBarrierRaster(Object inAdditiveBarrierRaster)

Sets the Input additive barrier raster parameter of this tool . This parameter is the travel distance from one raster cell to the next based on this formula: (average cost value in the neighboring cells) x (distance between cell centers) This is an optional parameter.

Parameters:

inAdditiveBarrierRaster - the travel distance from one raster cell to the next based on this formula: (average cost value in the neighboring cells) x (distance between cell centers)

getInCumulativeBarrierRaster

public Object getInCumulativeBarrierRaster()

Returns the Input cumulative barrier raster parameter of this tool . This parameter is the travel distance from one raster cell to the next based on this formula: (difference between cost values in the neighboring cells) + (distance between cell centers) This is an optional parameter.

Returns:

the Input cumulative barrier raster

setInCumulativeBarrierRaster

public void setInCumulativeBarrierRaster(Object inCumulativeBarrierRaster)

Sets the Input cumulative barrier raster parameter of this tool . This parameter is the travel distance from one raster cell to the next based on this formula: (difference between cost values in the neighboring cells) + (distance between cell centers) This is an optional parameter.

Parameters:

inCumulativeBarrierRaster - the travel distance from one raster cell to the next based on this formula: (difference between cost values in the neighboring cells) + (distance between cell centers)

getInFlowBarrierRaster

public Object getInFlowBarrierRaster()

Returns the Input flow barrier raster parameter of this tool . This parameter is a flow barrier is used when interpolating data with preferential direction of data variation, based on this formula: indicator (cost values in the neighboring cell > cost values in the neighboring cell) * (cost values in the neighboring cell - cost values in the neighboring cell) + (distance between cell centers), where indicator(true) = 1 and indicator(false) = 0. This is an optional parameter.

Returns:

the Input flow barrier raster

setInFlowBarrierRaster

public void setInFlowBarrierRaster(Object inFlowBarrierRaster)

Sets the Input flow barrier raster parameter of this tool . This parameter is a flow barrier is used when interpolating data with preferential direction of data variation, based on this formula: indicator (cost values in the neighboring cell > cost values in the neighboring cell) * (cost values in the neighboring cell - cost values in the neighboring cell) + (distance between cell centers), where indicator(true) = 1 and indicator(false) = 0. This is an optional parameter.

Parameters:

inFlowBarrierRaster - a flow barrier is used when interpolating data with preferential direction of data variation, based on this formula: indicator (cost values in the neighboring cell > cost values in the neighboring cell) * (cost values in the neighboring cell - cost values in the neighboring cell) + (distance between cell centers), where indicator(true) = 1 and indicator(false) = 0.

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.

getNumberIterations

public int getNumberIterations()

Returns the Number of iterations parameter of this tool . This parameter is the iteration count controls the accuracy of the numerical solution because the model solves the diffusion equation numerically. The larger this number, the more accurate the predictions, yet the longer the processing time. And, the more complex the barrier's geometry and the larger the bandwidth, the more iterations are required for an accurate predictions. This is an optional parameter.

Returns:

the Number of iterations

setNumberIterations

public void setNumberIterations(int numberIterations)

Sets the Number of iterations parameter of this tool . This parameter is the iteration count controls the accuracy of the numerical solution because the model solves the diffusion equation numerically. The larger this number, the more accurate the predictions, yet the longer the processing time. And, the more complex the barrier's geometry and the larger the bandwidth, the more iterations are required for an accurate predictions. This is an optional parameter.

Parameters:

numberIterations - the iteration count controls the accuracy of the numerical solution because the model solves the diffusion equation numerically. The larger this number, the more accurate the predictions, yet the longer the processing time. And, the more complex the barrier's geometry and the larger the bandwidth, the more iterations are required for an accurate predictions.

getWeightField

public Object getWeightField()

Returns the Weight field parameter of this tool . This parameter is used to emphasize an observation. The larger the weight, the more impact it has on the prediction. For coincident observations, assign the largest weight to the most reliable measurement. This is an optional parameter.

Returns:

the Weight field

setWeightField

public void setWeightField(Object weightField)

Sets the Weight field parameter of this tool . This parameter is used to emphasize an observation. The larger the weight, the more impact it has on the prediction. For coincident observations, assign the largest weight to the most reliable measurement. This is an optional parameter.

Parameters:

weightField - used to emphasize an observation. The larger the weight, the more impact it has on the prediction. For coincident observations, assign the largest weight to the most reliable measurement.

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