com.esri.arcgis.geoprocessing.tools.spatialstatisticstools
Class AverageNearestNeighbor

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

public class AverageNearestNeighbor
extends AbstractGPTool

Calculates a nearest neighbor index based on the average distance from each feature to its nearest neighboring feature. The Average Nearest Neighbor tool is contained in the Spatial Statistics Tools tool box.
Learn more about how Average Nearest Neighbor Distance works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AverageNearestNeighbor()
          Creates the Average Nearest Neighbor tool with defaults.
AverageNearestNeighbor(Object inputFeatureClass, String distanceMethod)
          Creates the Average Nearest Neighbor tool with the required parameters.
 
Method Summary
 double getArea()
          Returns the Area parameter of this tool .
 String getDisplayOutputGraphically()
          Returns the Display Output Graphically parameter of this tool .
 String getDistanceMethod()
          Returns the Distance Method parameter of this tool .
 Object getInputFeatureClass()
          Returns the Input Feature Class parameter of this tool .
 double getNNRatio()
          Returns the NNRatio parameter of this tool (Read only).
 double getNNZScore()
          Returns the NNZScore parameter of this tool (Read only).
 double getPValue()
          Returns the PValue parameter of this tool (Read only).
 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.
 void setArea(double area)
          Sets the Area parameter of this tool .
 void setDisplayOutputGraphically(String displayOutputGraphically)
          Sets the Display Output Graphically parameter of this tool .
 void setDistanceMethod(String distanceMethod)
          Sets the Distance Method parameter of this tool .
 void setInputFeatureClass(Object inputFeatureClass)
          Sets the Input Feature Class 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

AverageNearestNeighbor

public AverageNearestNeighbor()
Creates the Average Nearest Neighbor tool with defaults.

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


AverageNearestNeighbor

public AverageNearestNeighbor(Object inputFeatureClass,
                              String distanceMethod)
Creates the Average Nearest 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:
inputFeatureClass - Feature Layer, the feature class, typically a point feature class, for which the average nearest neighbor distance will be calculated.
distanceMethod - String, specifies how distances are calculated from each feature to its nearest neighboring feature.
Method Detail

getInputFeatureClass

public Object getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class, typically a point feature class, for which the average nearest neighbor distance will be calculated. This is a required parameter.

Returns:
the Input Feature Class

setInputFeatureClass

public void setInputFeatureClass(Object inputFeatureClass)
Sets the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class, typically a point feature class, for which the average nearest neighbor distance will be calculated. This is a required parameter.

Parameters:
inputFeatureClass - Feature Layer, the feature class, typically a point feature class, for which the average nearest neighbor distance will be calculated.

getDistanceMethod

public String getDistanceMethod()
Returns the Distance Method parameter of this tool . This parameter is String, specifies how distances are calculated from each feature to its nearest neighboring feature. This is a required parameter.

Returns:
the Distance Method

setDistanceMethod

public void setDistanceMethod(String distanceMethod)
Sets the Distance Method parameter of this tool . This parameter is String, specifies how distances are calculated from each feature to its nearest neighboring feature. This is a required parameter.

Parameters:
distanceMethod - String, specifies how distances are calculated from each feature to its nearest neighboring feature.

getDisplayOutputGraphically

public String getDisplayOutputGraphically()
Returns the Display Output Graphically parameter of this tool . This parameter is String, specifies whether the tool will display the nearest neighbor index graphically. This is an optional parameter.

Returns:
the Display Output Graphically

setDisplayOutputGraphically

public void setDisplayOutputGraphically(String displayOutputGraphically)
Sets the Display Output Graphically parameter of this tool . This parameter is String, specifies whether the tool will display the nearest neighbor index graphically. This is an optional parameter.

Parameters:
displayOutputGraphically - String, specifies whether the tool will display the nearest neighbor index graphically.

getArea

public double getArea()
Returns the Area parameter of this tool . This parameter is Double, a numeric value representing the study area size. The default value is the area of the minimum enclosing rectangle that would encompass all features (or all selected features). Units should match those for the Output Coordinate System. This is an optional parameter.

Returns:
the Area

setArea

public void setArea(double area)
Sets the Area parameter of this tool . This parameter is Double, a numeric value representing the study area size. The default value is the area of the minimum enclosing rectangle that would encompass all features (or all selected features). Units should match those for the Output Coordinate System. This is an optional parameter.

Parameters:
area - Double, a numeric value representing the study area size. The default value is the area of the minimum enclosing rectangle that would encompass all features (or all selected features). Units should match those for the Output Coordinate System.

getNNRatio

public double getNNRatio()
Returns the NNRatio parameter of this tool (Read only). This is an derived parameter.

Returns:
the NNRatio

getNNZScore

public double getNNZScore()
Returns the NNZScore parameter of this tool (Read only). This is an derived parameter.

Returns:
the NNZScore

getPValue

public double getPValue()
Returns the PValue parameter of this tool (Read only). This is an derived parameter.

Returns:
the PValue

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