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

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

All Implemented Interfaces:

GPTool

public class Basin

extends AbstractGPTool

Creates a raster delineating all drainage basins. The Basin tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Basin works

Software restrictions: none

Usage tips:

• Best results will be obtained from the Basin function if the Force option is used when creating the Flow Direction raster.
• All cells in the raster will belong to a basin, even if that basin is only one cell.
• The output of Basin is an integer raster.

Field Summary

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

vals

Constructor Summary

Basin()
Creates the Basin tool with defaults.

Basin(java.lang.Object inFlowDirectionRaster, java.lang.Object outRaster)
Creates the Basin tool with the required parameters.

Method Summary

java.lang.Object	getInFlowDirectionRaster() Returns the Input flow direction raster parameter of this tool .
java.lang.Object	getOutRaster() Returns the Output raster 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	setInFlowDirectionRaster(java.lang.Object inFlowDirectionRaster) Sets the Input flow direction raster parameter of this tool .
void	setOutRaster(java.lang.Object outRaster) Sets the Output raster 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

Basin

public Basin()

Creates the Basin tool with defaults.

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

Basin

public Basin(java.lang.Object inFlowDirectionRaster,
             java.lang.Object outRaster)

Creates the Basin 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 - Composite Geodataset, this is created with the Flow Direction function.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInFlowDirectionRaster

public java.lang.Object getInFlowDirectionRaster()

Returns the Input flow direction raster parameter of this tool . This parameter is Composite Geodataset, this is created with the Flow Direction function. This is a required parameter.

Returns:

the Input flow direction raster

setInFlowDirectionRaster

public void setInFlowDirectionRaster(java.lang.Object inFlowDirectionRaster)

Sets the Input flow direction raster parameter of this tool . This parameter is Composite Geodataset, this is created with the Flow Direction function. This is a required parameter.

Parameters:

inFlowDirectionRaster - Composite Geodataset, this is created with the Flow Direction function.

getOutRaster

public java.lang.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(java.lang.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.

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