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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.NaturalNeighbor

All Implemented Interfaces:

GPTool

public class NaturalNeighbor
extends AbstractGPTool

Interpolates a surface from points using a natural neighbor technique. The Natural Neighbor tool is contained in the 3D Analyst Tools tool box.

Software restrictions: none

Usage tips:

• 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. Interpolation functions may handle this data condition differently, in some cases using the first coincident point encountered for the calculation, or sometimes the last. 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.
• If the cell center of the perimeter cells of the output raster fall outside the convex hull; (defined by the input points) then those cells will be assigned NoData values. If an input point falls within one of these perimeter cells and the cell center falls outside the convex hull, the cell will still be assigned a value of NoData.
• This tool has a limit of approximately 15 million input points. If your input feature class contains more than a very large number of points (around 15 million or greater), the tool may fail to create a result. You can avoid this limit by processing your study area in several sections and mosaicking the results; into a single large raster dataset. Ensure that there is some overlap betweem the sections. Alternatively, you can use a Terrain geodatabase; to store and visualize points and surfaces comprised of billions of measurement points.
• If ArcGIS 3D Analyst is available, an alternative approach is to use TIN to Raster. First, create a TIN with the TIN Creation tools. Convert the TIN to a raster with TIN to Raster using the Natural Neighbors option. This is particularly useful if you have breaklines or an irregularly shaped data area.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

NaturalNeighbor()
Creates the Natural Neighbor tool with defaults.

NaturalNeighbor(Object inPointFeatures, Object zField, Object outRaster)
Creates the Natural Neighbor 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	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	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	setOutRaster(Object outRaster) Sets the Output raster 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

NaturalNeighbor

public NaturalNeighbor()

Creates the Natural Neighbor tool with defaults.

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

NaturalNeighbor

public NaturalNeighbor(Object inPointFeatures,
                       Object zField,
                       Object outRaster)

Creates the Natural Neighbor 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 - Composite Geodataset, the input point features containing the z-values to be interpolated into a surface raster.

zField - Field, this can be a numeric field or the Shape field if the in_point_features contain z-values.

outRaster - Raster Dataset, output raster dataset.

Method Detail

getInPointFeatures

public Object getInPointFeatures()

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

Parameters:

inPointFeatures - Composite Geodataset, 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 Field, this can be a numeric field or the Shape field if the in_point_features contain 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 Field, this can be a numeric field or the Shape field if the in_point_features contain z-values. This is a required parameter.

Parameters:

zField - Field, this can be a numeric field or the Shape field if the in_point_features contain z-values.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, output raster dataset. 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 Raster Dataset, output raster dataset. This is a required parameter.

Parameters:

outRaster - Raster Dataset, output raster dataset.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is Analysis cell size, 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 in_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 Analysis cell size, 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 in_point_features in the input spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - Analysis cell size, 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 in_point_features in the input spatial reference, divided by 250.

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