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

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

All Implemented Interfaces:

GPTool

public class StreamLink
extends AbstractGPTool

Assigns unique values to sections of a raster linear network between intersections. The Stream Link tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Links are the sections of a stream channel connecting two successive junctions, a junction and the outlet, or a junction and the drainage divide. Illustration of the links in a stream channel
• The input stream raster can be created by "thresholding" the results of the Flow Accumulation tool.
• The stream raster linear network should be represented as values greater than or equal to one on a background of NoData.

Field Summary

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

vals

Constructor Summary

StreamLink()
Creates the Stream Link tool with defaults.

StreamLink(Object inStreamRaster, Object inFlowDirectionRaster, Object outRaster)
Creates the Stream Link tool with the required parameters.

Method Summary

Object	getInFlowDirectionRaster() Returns the Input flow direction raster parameter of this tool .
Object	getInStreamRaster() Returns the Input stream raster parameter of this tool .
Object	getOutRaster() Returns the Output raster 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	setInStreamRaster(Object inStreamRaster) Sets the Input stream raster parameter of this tool .
void	setOutRaster(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

StreamLink

public StreamLink()

Creates the Stream Link tool with defaults.

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

StreamLink

public StreamLink(Object inStreamRaster,
                  Object inFlowDirectionRaster,
                  Object outRaster)

Creates the Stream Link 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:

inStreamRaster - an input raster that represents a linear stream network.

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.

outRaster - the output stream link raster. it will be of integer type.

Method Detail

getInStreamRaster

public Object getInStreamRaster()

Returns the Input stream raster parameter of this tool . This parameter is an input raster that represents a linear stream network. This is a required parameter.

Returns:

the Input stream raster

setInStreamRaster

public void setInStreamRaster(Object inStreamRaster)

Sets the Input stream raster parameter of this tool . This parameter is an input raster that represents a linear stream network. This is a required parameter.

Parameters:

inStreamRaster - an input raster that represents a linear stream network.

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.

getOutRaster

public Object getOutRaster()

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

Parameters:

outRaster - the output stream link raster. it will be of integer type.

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