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

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

All Implemented Interfaces:

GPTool

public class StreamOrder
extends AbstractGPTool

Assigns a numeric order to segments of a raster representing branches of a linear network. The Stream Order tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The output of Stream Order will be of higher quality if the input stream raster and input flow direction raster are derived from the same surface. If the stream raster is derived from a rasterized streams dataset, the output may not be usable because, on a cell-by-cell basis, the direction will not correspond with the location of stream cells.
• The results of the Flow Accumulation tool can be used to create a raster stream network by applying a threshold value to select cells with a high accumulated flow. For example, cells that have more than 100 cells flowing into them are used to define the stream network. Use the Con or Set Null tool to create a stream network raster where flow accumulation values of 100 or greater go to one, and the remainder are put to the background (NoData). The resulting stream network can be used in Stream Link and Stream to Feature.An analytical method for determining an appropriate threshold value for stream network delineation is presented in Tarboton, et al. (1991).

Field Summary

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

vals

Constructor Summary

StreamOrder()
Creates the Stream Order tool with defaults.

StreamOrder(Object inStreamRaster, Object inFlowDirectionRaster, Object outRaster)
Creates the Stream Order 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 .
String	getOrderMethod() Returns the Method of stream ordering 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	setOrderMethod(String orderMethod) Sets the Method of stream ordering 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

StreamOrder

public StreamOrder()

Creates the Stream Order tool with defaults.

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

StreamOrder

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

Creates the Stream Order 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. the input stream raster linear network should be represented as values greater than or equal to one on a background of NoData.

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 order 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. the input stream raster linear network should be represented as values greater than or equal to one on a background of NoData. 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. the input stream raster linear network should be represented as values greater than or equal to one on a background of NoData. This is a required parameter.

Parameters:

inStreamRaster - an input raster that represents a linear stream network. the input stream raster linear network should be represented as values greater than or equal to one on a background of NoData.

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 order 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 order raster. it will be of integer type. This is a required parameter.

Parameters:

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

getOrderMethod

public String getOrderMethod()

Returns the Method of stream ordering parameter of this tool . This parameter is the method used for assigning stream order. This is an optional parameter.

Returns:

the Method of stream ordering

setOrderMethod

public void setOrderMethod(String orderMethod)

Sets the Method of stream ordering parameter of this tool . This parameter is the method used for assigning stream order. This is an optional parameter.

Parameters:

orderMethod - the method used for assigning stream order.

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