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

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

All Implemented Interfaces:

GPTool

public class IDW
extends AbstractGPTool

The IDW tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• The predicted value is limited to the range of the values used to interpolate. Because IDW is a weighted distance average, the average cannot be greater than the highest or less than the lowest input. Therefore, it cannot create ridges or valleys if these extremes have not already been sampled.
• IDW can produce "bulls eyes" around data locations.
• There are no assumptions required of the input data.
• This method is well suited to be used with very large input datasets.

Field Summary

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

vals

Constructor Summary

IDW()
Creates the IDW tool with defaults.

IDW(Object inFeatures, Object zField)
Creates the IDW tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getInFeatures() Returns the Input feature class 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 .
double	getPower() Returns the Power parameter of this tool .
Object	getSearchNeighborhood() Returns the Search neighborhood 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	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input feature class 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	setPower(double power) Sets the Power parameter of this tool .
void	setSearchNeighborhood(Object searchNeighborhood) Sets the Search neighborhood 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

IDW

public IDW()

Creates the IDW tool with defaults.

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

IDW

public IDW(Object inFeatures,
           Object zField)

Creates the IDW 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.

getPower

public double getPower()

Returns the Power parameter of this tool . This parameter is the exponent of distance that controls the significance of surrounding points on the interpolated value. A higher power results in less influence from distant points. This is an optional parameter.

Returns:

the Power

setPower

public void setPower(double power)

Sets the Power parameter of this tool . This parameter is the exponent of distance that controls the significance of surrounding points on the interpolated value. A higher power results in less influence from distant points. This is an optional parameter.

Parameters:

power - the exponent of distance that controls the significance of surrounding points on the interpolated value. A higher power results in less influence from distant points.

getSearchNeighborhood

public Object getSearchNeighborhood()

Returns the Search neighborhood parameter of this tool . This parameter is defines which surrounding points will be used to control the output. There are two options: STANDARD and SMOOTH. Standard is the default. this is a Search Neighborhood class ( SearchNeighborhoodStandard and SearchNeighborhoodSmooth). sTANDARD sMOOTH This is an optional parameter.

Returns:

the Search neighborhood

setSearchNeighborhood

public void setSearchNeighborhood(Object searchNeighborhood)

Sets the Search neighborhood parameter of this tool . This parameter is defines which surrounding points will be used to control the output. There are two options: STANDARD and SMOOTH. Standard is the default. this is a Search Neighborhood class ( SearchNeighborhoodStandard and SearchNeighborhoodSmooth). sTANDARD sMOOTH This is an optional parameter.

Parameters:

searchNeighborhood - defines which surrounding points will be used to control the output. There are two options: STANDARD and SMOOTH. Standard is the default. this is a Search Neighborhood class ( SearchNeighborhoodStandard and SearchNeighborhoodSmooth). sTANDARD sMOOTH

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