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

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

All Implemented Interfaces:

GPTool

public class StreamToFeature
extends AbstractGPTool

Converts a raster representing a linear network to features representing the linear network. The Stream to Feature tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The input stream raster linear network should be represented as values greater than or equal to one on a background of NoData.
• 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).
• There should be contiguous features with the same value, such as the results of the Stream Order or Stream Link tool. Stream to Feature should not be used on a raster in which there are few adjacent cells of the same value.
• The arcs of the output shapefile will point downstream.

Field Summary

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

vals

Constructor Summary

StreamToFeature()
Creates the Stream to Feature tool with defaults.

StreamToFeature(Object inStreamRaster, Object inFlowDirectionRaster, Object outPolylineFeatures)
Creates the Stream to Feature 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	getOutPolylineFeatures() Returns the Output polyline features parameter of this tool .
String	getSimplify() Returns the Simplify polylines 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	setOutPolylineFeatures(Object outPolylineFeatures) Sets the Output polyline features parameter of this tool .
void	setSimplify(String simplify) Sets the Simplify polylines 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

StreamToFeature

public StreamToFeature()

Creates the Stream to Feature tool with defaults.

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

StreamToFeature

public StreamToFeature(Object inStreamRaster,
                       Object inFlowDirectionRaster,
                       Object outPolylineFeatures)

Creates the Stream to Feature 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.

outPolylineFeatures - output feature class that will hold the converted streams.

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.

getOutPolylineFeatures

public Object getOutPolylineFeatures()

Returns the Output polyline features parameter of this tool . This parameter is output feature class that will hold the converted streams. This is a required parameter.

Returns:

the Output polyline features

setOutPolylineFeatures

public void setOutPolylineFeatures(Object outPolylineFeatures)

Sets the Output polyline features parameter of this tool . This parameter is output feature class that will hold the converted streams. This is a required parameter.

Parameters:

outPolylineFeatures - output feature class that will hold the converted streams.

getSimplify

public String getSimplify()

Returns the Simplify polylines parameter of this tool . This parameter is specifies whether weeding is used. by default, weeding is applied. This is an optional parameter.

Returns:

the Simplify polylines

setSimplify

public void setSimplify(String simplify)

Sets the Simplify polylines parameter of this tool . This parameter is specifies whether weeding is used. by default, weeding is applied. This is an optional parameter.

Parameters:

simplify - specifies whether weeding is used. by default, weeding is applied.

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