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

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

All Implemented Interfaces:

GPTool

public class Thiessen
extends AbstractGPTool

Converts input coverage points to an output coverage of Thiessen proximal polygons. The Thiessen tool is contained in the Coverage Tools tool box.

Usage tips:

• Thiessen polygons have the unique property that each polygon contains only one input point, and any location within a polygon is closer to its associated point than to the point of any other polygon.
• To ignore close points, specify a proximal tolerance. For point coverages with an automation scale between 1:10,000 and 1:100,000, try a tolerance between 1.668 ft (0.508 m) and 16.620 ft (5.080 m).
• The Output Coverage inherits these data model contents from the Input Coverage: items from the point attribute table, tics, and the projection file.
• Thiessen polygons can be used to apportion a point coverage into regions known as Thiessen or Voronoi polygons. Each region contains only one Input Coverage point. Each region has the unique property that any location within a region is closer to the region's point than to the point of any other region.
• All items in the Input Coverage point attribute table (PAT) are copied to their associated polygons in the Output Coverage PAT.
• The Output Coverage polygon label points are located at the same positions as the Input Coverage points.
• If the Input Coverage has a PRJ file, it is copied to the Output Coverage.

Field Summary

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

vals

Constructor Summary

Thiessen()
Creates the Thiessen tool with defaults.

Thiessen(Object inCover, Object outCover)
Creates the Thiessen tool with the required parameters.

Method Summary

Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool .
double	getProximalTolerance() Returns the Proximal Tolerance 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	setInCover(Object inCover) Sets the Input Coverage parameter of this tool .
void	setOutCover(Object outCover) Sets the Output Coverage parameter of this tool .
void	setProximalTolerance(double proximalTolerance) Sets the Proximal Tolerance 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

Thiessen

public Thiessen()

Creates the Thiessen tool with defaults.

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

Thiessen

public Thiessen(Object inCover,
                Object outCover)

Creates the Thiessen 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:

inCover - the coverage that must have a point feature attribute table created by BUILD with the POINT option.

outCover - the polygon coverage in which the Thiessen proximal polygons will be produced.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage that must have a point feature attribute table created by BUILD with the POINT option. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the coverage that must have a point feature attribute table created by BUILD with the POINT option. This is a required parameter.

Parameters:

inCover - the coverage that must have a point feature attribute table created by BUILD with the POINT option.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the polygon coverage in which the Thiessen proximal polygons will be produced. This is a required parameter.

Returns:

the Output Coverage

setOutCover

public void setOutCover(Object outCover)

Sets the Output Coverage parameter of this tool . This parameter is the polygon coverage in which the Thiessen proximal polygons will be produced. This is a required parameter.

Parameters:

outCover - the polygon coverage in which the Thiessen proximal polygons will be produced.

getProximalTolerance

public double getProximalTolerance()

Returns the Proximal Tolerance parameter of this tool . This parameter is tolerance used to eliminate Input Coverage points that fall within the specified distance of other Input Coverage points. The default Proximal Tolerance is the machine precision of the computer. This is an optional parameter.

Returns:

the Proximal Tolerance

setProximalTolerance

public void setProximalTolerance(double proximalTolerance)

Sets the Proximal Tolerance parameter of this tool . This parameter is tolerance used to eliminate Input Coverage points that fall within the specified distance of other Input Coverage points. The default Proximal Tolerance is the machine precision of the computer. This is an optional parameter.

Parameters:

proximalTolerance - tolerance used to eliminate Input Coverage points that fall within the specified distance of other Input Coverage points. The default Proximal Tolerance is the machine precision of the computer.

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