com.esri.arcgis.geoprocessing.tools.coveragetools
Class PointDistance

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.PointDistance

All Implemented Interfaces:

GPTool

public class PointDistance

extends AbstractGPTool

The Point Distance tool is contained in the Coverage Tools tool box.
Learn more about how Point Distance works

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• Distance is set to zero when no match is found within the search radius; for a particular point. If no matching points are found, the tool gives a warning, and no output info table is created.
• Point Distance will not work if either coverage contains more than 130,000 points.
• The output INFO table can become very large when both coverages contain many points. Use a smaller search radius to limit the number of combinations.
• If Point Distance is used to calculate the distance between other points in a single coverage, the cover# will have an A and a B appended to the item name.
• Projection files will be compared for similarity using the level of comparison specified with the Project Compare environment setting. For more information, see Compare Projections;
• The results are recorded in an output table containing items for the internal numbers and distance. The input with the highest precision for distance is the one used for the output INFO distance field.COLUMN ITEM NAME WIDTH OUTPUT TYPE NDEC; 1 # 4 6 B -; 5 # 4 6 B -; 9 DISTANCE 4 12 F 3; (single precision); Or; 9 DISTANCE 8 18 F 5; (double precision);
• The following environments affect this tool: derivedPrecision; newPrecision; projectCompare; scratchWorkspace; , and workspace;

Field Summary

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

vals

Constructor Summary

PointDistance()
Creates the Point Distance tool with defaults.

PointDistance(java.lang.Object fromCover, java.lang.Object toCover, java.lang.Object outInfoTable)
Creates the Point Distance tool with the required parameters.

Method Summary

java.lang.Object	getFromCover() Returns the From Coverage parameter of this tool .
java.lang.Object	getOutInfoTable() Returns the Output Info Table parameter of this tool .
double	getSearchRadius() Returns the Search Radius parameter of this tool .
java.lang.Object	getToCover() Returns the To Coverage parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setFromCover(java.lang.Object fromCover) Sets the From Coverage parameter of this tool .
void	setOutInfoTable(java.lang.Object outInfoTable) Sets the Output Info Table parameter of this tool .
void	setSearchRadius(double searchRadius) Sets the Search Radius parameter of this tool .
void	setToCover(java.lang.Object toCover) Sets the To Coverage 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

PointDistance

public PointDistance()

Creates the Point Distance tool with defaults.

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

PointDistance

public PointDistance(java.lang.Object fromCover,
                     java.lang.Object toCover,
                     java.lang.Object outInfoTable)

Creates the Point Distance 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:

fromCover - Coverage, the point coverage for which distances to another coverage's points are to be computed.

toCover - Coverage, the point coverage from which point distances are to be measured. Distances between all points in the same coverage can be calculated by specifying the same coverage name for both and arguments.

outInfoTable - ArcInfo Table, the INFO data table created by Point Distance, which holds the distance measurements. The number of records created in

depends on the search radius used, but it can be as large as the number of points in the times the number of points in the .

Method Detail

getFromCover

public java.lang.Object getFromCover()

Returns the From Coverage parameter of this tool . This parameter is Coverage, the point coverage for which distances to another coverage's points are to be computed. This is a required parameter.

Returns:

the From Coverage

setFromCover

public void setFromCover(java.lang.Object fromCover)

Sets the From Coverage parameter of this tool . This parameter is Coverage, the point coverage for which distances to another coverage's points are to be computed. This is a required parameter.

Parameters:

fromCover - Coverage, the point coverage for which distances to another coverage's points are to be computed.

getToCover

public java.lang.Object getToCover()

Returns the To Coverage parameter of this tool . This parameter is Coverage, the point coverage from which point distances are to be measured. Distances between all points in the same coverage can be calculated by specifying the same coverage name for both and arguments. This is a required parameter.

Returns:

the To Coverage

setToCover

public void setToCover(java.lang.Object toCover)

Sets the To Coverage parameter of this tool . This parameter is Coverage, the point coverage from which point distances are to be measured. Distances between all points in the same coverage can be calculated by specifying the same coverage name for both and arguments. This is a required parameter.

Parameters:

toCover - Coverage, the point coverage from which point distances are to be measured. Distances between all points in the same coverage can be calculated by specifying the same coverage name for both and arguments.

getOutInfoTable

public java.lang.Object getOutInfoTable()

Returns the Output Info Table parameter of this tool . This parameter is ArcInfo Table, the INFO data table created by Point Distance, which holds the distance measurements. The number of records created in

depends on the search radius used, but it can be as large as the number of points in the times the number of points in the . This is a required parameter.

Returns:

the Output Info Table

setOutInfoTable

public void setOutInfoTable(java.lang.Object outInfoTable)

Sets the Output Info Table parameter of this tool . This parameter is ArcInfo Table, the INFO data table created by Point Distance, which holds the distance measurements. The number of records created in

depends on the search radius used, but it can be as large as the number of points in the times the number of points in the . This is a required parameter.

Parameters:

outInfoTable - ArcInfo Table, the INFO data table created by Point Distance, which holds the distance measurements. The number of records created in

depends on the search radius used, but it can be as large as the number of points in the times the number of points in the .

getSearchRadius

public double getSearchRadius()

Returns the Search Radius parameter of this tool . This parameter is Double, the maximum distance in coverage units a feature can be from the current point for consideration as the closest feature. The default is the width or height of the near coverage BND divided by 100, whichever is larger. This is an optional parameter.

Returns:

the Search Radius

setSearchRadius

public void setSearchRadius(double searchRadius)

Sets the Search Radius parameter of this tool . This parameter is Double, the maximum distance in coverage units a feature can be from the current point for consideration as the closest feature. The default is the width or height of the near coverage BND divided by 100, whichever is larger. This is an optional parameter.

Parameters:

searchRadius - Double, the maximum distance in coverage units a feature can be from the current point for consideration as the closest feature. The default is the width or height of the near coverage BND divided by 100, whichever is larger.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias