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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.analyst3dtools.Idw
All Implemented Interfaces:
GPTool

public class Idw
extends AbstractGPTool

Interpolates a raster surface from points using an inverse distance weighted (IDW) technique. The IDW tool is contained in the 3D Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Idw()
          Creates the IDW tool with defaults.
Idw(Object inPointFeatures, Object zField, Object outRaster)
          Creates the IDW tool with the required parameters.
 
Method Summary
 Object getCellSize()
          Returns the Output cell size parameter of this tool .
 Object getInBarrierPolylineFeatures()
          Returns the Input barrier polyline features parameter of this tool .
 Object getInPointFeatures()
          Returns the Input point features parameter of this tool .
 Object getOutRaster()
          Returns the Output raster parameter of this tool .
 double getPower()
          Returns the Power parameter of this tool .
 Object getSearchRadius()
          Returns the Search radius 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 setInBarrierPolylineFeatures(Object inBarrierPolylineFeatures)
          Sets the Input barrier polyline features parameter of this tool .
 void setInPointFeatures(Object inPointFeatures)
          Sets the Input point features 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 setSearchRadius(Object searchRadius)
          Sets the Search radius 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 inPointFeatures,
           Object zField,
           Object outRaster)
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:
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.
outRaster - the output interpolated surface raster.
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.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is the output interpolated surface raster. This is a required parameter.

Returns:
the Output raster

setOutRaster

public void setOutRaster(Object outRaster)
Sets the Output raster parameter of this tool . This parameter is the output interpolated surface raster. This is a required parameter.

Parameters:
outRaster - the output interpolated surface raster.

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.

getPower

public double getPower()
Returns the Power parameter of this tool . This parameter is the exponent of distance. controls the significance of surrounding points on the interpolated value. A higher power results in less influence from distant points. it can be any real number greater than 0, but the most reasonable results will be obtained using values from 0.5 to 3. The default is 2. 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. controls the significance of surrounding points on the interpolated value. A higher power results in less influence from distant points. it can be any real number greater than 0, but the most reasonable results will be obtained using values from 0.5 to 3. The default is 2. This is an optional parameter.

Parameters:
power - the exponent of distance. controls the significance of surrounding points on the interpolated value. A higher power results in less influence from distant points. it can be any real number greater than 0, but the most reasonable results will be obtained using values from 0.5 to 3. The default is 2.

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

getInBarrierPolylineFeatures

public Object getInBarrierPolylineFeatures()
Returns the Input barrier polyline features parameter of this tool . This parameter is polyline features to be used as a break or limit in searching for the input sample points. This is an optional parameter.

Returns:
the Input barrier polyline features

setInBarrierPolylineFeatures

public void setInBarrierPolylineFeatures(Object inBarrierPolylineFeatures)
Sets the Input barrier polyline features parameter of this tool . This parameter is polyline features to be used as a break or limit in searching for the input sample points. This is an optional parameter.

Parameters:
inBarrierPolylineFeatures - polyline features to be used as a break or limit in searching for the input sample points.

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