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

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

All Implemented Interfaces:

GPTool

public class Watershed
extends AbstractGPTool

Determines the contributing area above a set of cells in a raster. The Watershed tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The value of each watershed will be taken from the value of the source in the input raster or feature pour point data. When the pour point is a raster dataset, the cell values will be used. When the pour point is a point feature dataset, the values will come from the specified field.
• Better results will be obtained if the tool is used beforehand to help locate the pour points to cells of high accumulated flow.

Field Summary

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

vals

Constructor Summary

Watershed()
Creates the Watershed tool with defaults.

Watershed(Object inFlowDirectionRaster, Object inPourPointData, Object outRaster)
Creates the Watershed tool with the required parameters.

Method Summary

Object	getInFlowDirectionRaster() Returns the Input flow direction 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 .
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	setInFlowDirectionRaster(Object inFlowDirectionRaster) Sets the Input flow direction 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 .

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

Watershed

public Watershed()

Creates the Watershed tool with defaults.

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

Watershed

public Watershed(Object inFlowDirectionRaster,
                 Object inPourPointData,
                 Object outRaster)

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

inFlowDirectionRaster - the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool.

inPourPointData - the input pour point locations. for a raster, this represents cells above which the contributing area, or catchment, will be determined. All cells that are not NoData will be used as source cells. for a feature dataset, this represents locations above which the contributing area, or catchment, will be determined.

outRaster - the output raster that shows the contributing area. it will be of integer type.

Method Detail

getInFlowDirectionRaster

public Object getInFlowDirectionRaster()

Returns the Input flow direction raster parameter of this tool . This parameter is the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool. This is a required parameter.

Returns:

the Input flow direction raster

setInFlowDirectionRaster

public void setInFlowDirectionRaster(Object inFlowDirectionRaster)

Sets the Input flow direction raster parameter of this tool . This parameter is the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool. This is a required parameter.

Parameters:

inFlowDirectionRaster - the input raster that shows the direction of flow out of each cell. the flow direction raster can be created using the Flow Direction tool.

getInPourPointData

public Object getInPourPointData()

Returns the Input raster or feature pour point data parameter of this tool . This parameter is the input pour point locations. for a raster, this represents cells above which the contributing area, or catchment, will be determined. All cells that are not NoData will be used as source cells. for a feature dataset, this represents locations above which the contributing area, or catchment, will be determined. 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 the input pour point locations. for a raster, this represents cells above which the contributing area, or catchment, will be determined. All cells that are not NoData will be used as source cells. for a feature dataset, this represents locations above which the contributing area, or catchment, will be determined. This is a required parameter.

Parameters:

inPourPointData - the input pour point locations. for a raster, this represents cells above which the contributing area, or catchment, will be determined. All cells that are not NoData will be used as source cells. for a feature dataset, this represents locations above which the contributing area, or catchment, will be determined.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster that shows the contributing area. it will be of integer type. 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 the output raster that shows the contributing area. it will be of integer type. This is a required parameter.

Parameters:

outRaster - the output raster that shows the contributing area. it will be of integer type.

getPourPointField

public Object getPourPointField()

Returns the Pour point field parameter of this tool . This parameter is field used to assign values to the pour point locations. if the pour point dataset is a raster, use Value. if the pour point dataset 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 used to assign values to the pour point locations. if the pour point dataset is a raster, use Value. if the pour point dataset 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 used to assign values to the pour point locations. if the pour point dataset is a raster, use Value. if the pour point dataset 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