com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class SnapPourPoint

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.SnapPourPoint

All Implemented Interfaces:

GPTool

public class SnapPourPoint
extends AbstractGPTool

Snaps pour points to the cell of highest flow accumulation within a specified distance. The Snap Pour Point tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Usage tips:

• The Snap Pour Point tool is used to ensure the selection of points of high accumulated flow when delineating drainage basins using the Watershed tool. Snap Pour Point will search within a snap distance around the specified pour points for the cell of highest accumulated flow and move the pour point to that location.
• If the input raster or feature pour point data is a point feature class, it will be converted to a raster internally for processing.
• The output is an integer raster when the original pour point locations have been snapped to locations of higher accumulated flow.

Field Summary

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

vals

Constructor Summary

SnapPourPoint()
Creates the Snap Pour Point tool with defaults.

SnapPourPoint(Object inPourPointData, Object inAccumulationRaster, Object outRaster, double snapDistance)
Creates the Snap Pour Point tool with the required parameters.

Method Summary

Object	getInAccumulationRaster() Returns the Input accumulation raster parameter of this tool .
Object	getInPourPointData() Returns the Input raster or feature pour point data parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
Object	getPourPointField() Returns the Pour point field parameter of this tool .
double	getSnapDistance() Returns the Snap distance 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	setInAccumulationRaster(Object inAccumulationRaster) Sets the Input accumulation raster parameter of this tool .
void	setInPourPointData(Object inPourPointData) Sets the Input raster or feature pour point data parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setPourPointField(Object pourPointField) Sets the Pour point field parameter of this tool .
void	setSnapDistance(double snapDistance) Sets the Snap distance 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

SnapPourPoint

public SnapPourPoint()

Creates the Snap Pour Point tool with defaults.

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

SnapPourPoint

public SnapPourPoint(Object inPourPointData,
                     Object inAccumulationRaster,
                     Object outRaster,
                     double snapDistance)

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

inPourPointData - Composite Geodataset, for point datasets, specifies the locations of cells that will be snapped.

inAccumulationRaster - Composite Geodataset, this can be created with the Flow Accumulation function.

outRaster - Raster Dataset, the raster to be created.

snapDistance - Double, maximum distance, in map units, to search for a cell of higher accumulated flow.

Method Detail

getInPourPointData

public Object getInPourPointData()

Returns the Input raster or feature pour point data parameter of this tool . This parameter is Composite Geodataset, for point datasets, specifies the locations of cells that will be snapped. This is a required parameter.

Returns:

the Input raster or feature pour point data

setInPourPointData

public void setInPourPointData(Object inPourPointData)

Sets the Input raster or feature pour point data parameter of this tool . This parameter is Composite Geodataset, for point datasets, specifies the locations of cells that will be snapped. This is a required parameter.

Parameters:

inPourPointData - Composite Geodataset, for point datasets, specifies the locations of cells that will be snapped.

getInAccumulationRaster

public Object getInAccumulationRaster()

Returns the Input accumulation raster parameter of this tool . This parameter is Composite Geodataset, this can be created with the Flow Accumulation function. This is a required parameter.

Returns:

the Input accumulation raster

setInAccumulationRaster

public void setInAccumulationRaster(Object inAccumulationRaster)

Sets the Input accumulation raster parameter of this tool . This parameter is Composite Geodataset, this can be created with the Flow Accumulation function. This is a required parameter.

Parameters:

inAccumulationRaster - Composite Geodataset, this can be created with the Flow Accumulation function.

getOutRaster

public Object getOutRaster()

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

Parameters:

outRaster - Raster Dataset, the raster to be created.

getSnapDistance

public double getSnapDistance()

Returns the Snap distance parameter of this tool . This parameter is Double, maximum distance, in map units, to search for a cell of higher accumulated flow. This is a required parameter.

Returns:

the Snap distance

setSnapDistance

public void setSnapDistance(double snapDistance)

Sets the Snap distance parameter of this tool . This parameter is Double, maximum distance, in map units, to search for a cell of higher accumulated flow. This is a required parameter.

Parameters:

snapDistance - Double, maximum distance, in map units, to search for a cell of higher accumulated flow.

getPourPointField

public Object getPourPointField()

Returns the Pour point field parameter of this tool . This parameter is Field, if in_pour_point_data is a feature, use a numeric field. If the field contains floating-point values, they will be truncated into integers. This is an optional parameter.

Returns:

the Pour point field

setPourPointField

public void setPourPointField(Object pourPointField)

Sets the Pour point field parameter of this tool . This parameter is Field, if in_pour_point_data is a feature, use a numeric field. If the field contains floating-point values, they will be truncated into integers. This is an optional parameter.

Parameters:

pourPointField - Field, if in_pour_point_data is a feature, use a numeric field. If the field contains floating-point values, they will be truncated into integers.

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