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

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

public class CalculateDistanceBand
extends AbstractGPTool

This tool calculates the distance for all features in the input feature class to their nth neighbor (specified in the Neighbors parameter). Then it examines the distances and returns three values: the maximum distance, the minimum distance and the average distance. The Calculate Distance Band from Neighbor Count tool is contained in the Spatial Statistics Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CalculateDistanceBand()
          Creates the Calculate Distance Band from Neighbor Count tool with defaults.
CalculateDistanceBand(Object inputFeatures, int neighbors, String distanceMethod)
          Creates the Calculate Distance Band from Neighbor Count tool with the required parameters.
 
Method Summary
 double getAverageDistance()
          Returns the Average Distance parameter of this tool (Read only).
 String getDistanceMethod()
          Returns the Distance Method parameter of this tool .
 Object getInputFeatures()
          Returns the Input Features parameter of this tool .
 double getMaximumDistance()
          Returns the Maximum Distance parameter of this tool (Read only).
 double getMinimumDistance()
          Returns the Minimum Distance parameter of this tool (Read only).
 int getNeighbors()
          Returns the Neighbors 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.
 void setDistanceMethod(String distanceMethod)
          Sets the Distance Method parameter of this tool .
 void setInputFeatures(Object inputFeatures)
          Sets the Input Features parameter of this tool .
 void setNeighbors(int neighbors)
          Sets the Neighbors 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

CalculateDistanceBand

public CalculateDistanceBand()
Creates the Calculate Distance Band from Neighbor Count tool with defaults.

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


CalculateDistanceBand

public CalculateDistanceBand(Object inputFeatures,
                             int neighbors,
                             String distanceMethod)
Creates the Calculate Distance Band from Neighbor Count 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:
inputFeatures - Feature Layer, the feature class or layer from which to calculate distance statistics.
neighbors - Long, the number of neighbors (n) to consider for each feature. This number should be any integer between one and the total number of features in the feature class. A list of distances between each feature and its nth neighbor is compiled and the maximum, minimum and average distances are returned.
distanceMethod - String, specifies how distances are calculated when calculating neighbor distance.
Method Detail

getInputFeatures

public Object getInputFeatures()
Returns the Input Features parameter of this tool . This parameter is Feature Layer, the feature class or layer from which to calculate distance statistics. This is a required parameter.

Returns:
the Input Features

setInputFeatures

public void setInputFeatures(Object inputFeatures)
Sets the Input Features parameter of this tool . This parameter is Feature Layer, the feature class or layer from which to calculate distance statistics. This is a required parameter.

Parameters:
inputFeatures - Feature Layer, the feature class or layer from which to calculate distance statistics.

getNeighbors

public int getNeighbors()
Returns the Neighbors parameter of this tool . This parameter is Long, the number of neighbors (n) to consider for each feature. This number should be any integer between one and the total number of features in the feature class. A list of distances between each feature and its nth neighbor is compiled and the maximum, minimum and average distances are returned. This is a required parameter.

Returns:
the Neighbors

setNeighbors

public void setNeighbors(int neighbors)
Sets the Neighbors parameter of this tool . This parameter is Long, the number of neighbors (n) to consider for each feature. This number should be any integer between one and the total number of features in the feature class. A list of distances between each feature and its nth neighbor is compiled and the maximum, minimum and average distances are returned. This is a required parameter.

Parameters:
neighbors - Long, the number of neighbors (n) to consider for each feature. This number should be any integer between one and the total number of features in the feature class. A list of distances between each feature and its nth neighbor is compiled and the maximum, minimum and average distances are returned.

getDistanceMethod

public String getDistanceMethod()
Returns the Distance Method parameter of this tool . This parameter is String, specifies how distances are calculated when calculating neighbor distance. 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 when calculating neighbor distance. This is a required parameter.

Parameters:
distanceMethod - String, specifies how distances are calculated when calculating neighbor distance.

getMinimumDistance

public double getMinimumDistance()
Returns the Minimum Distance parameter of this tool (Read only). This is an derived parameter.

Returns:
the Minimum Distance

getAverageDistance

public double getAverageDistance()
Returns the Average Distance parameter of this tool (Read only). This is an derived parameter.

Returns:
the Average Distance

getMaximumDistance

public double getMaximumDistance()
Returns the Maximum Distance parameter of this tool (Read only). This is an derived parameter.

Returns:
the Maximum Distance

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