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.
Learn more about how Stream Link works

Software restrictions: none

Usage tips:

• The input stream raster can be created by "thresholding" the results of the Flow Accumulation function. Refer to the Flow Accumulation topic for an example.
• The stream raster linear network should be represented as values greater than or equal to one on a background of NoData.
• The output of the Stream Link tool is an integer raster.

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 - Composite Geodataset, an input raster that represents a linear stream network.

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

outRaster - Raster Dataset, the output stream link raster.

Method Detail

getInStreamRaster

public Object getInStreamRaster()

Returns the Input stream raster parameter of this tool . This parameter is Composite Geodataset, 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 Composite Geodataset, an input raster that represents a linear stream network. This is a required parameter.

Parameters:

inStreamRaster - Composite Geodataset, 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 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(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 Object getOutRaster()

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

Parameters:

outRaster - Raster Dataset, the output stream link raster.

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