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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.FlowDirection
All Implemented Interfaces:
GPTool

public class FlowDirection
extends AbstractGPTool

Creates a raster of flow direction from each cell to its steepest downslope neighbor. The Flow Direction tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Flow Direction works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
FlowDirection()
          Creates the Flow Direction tool with defaults.
FlowDirection(Object inSurfaceRaster, Object outFlowDirectionRaster)
          Creates the Flow Direction tool with the required parameters.
 
Method Summary
 String getForceFlow()
          Returns the Force all edge cells to flow outward parameter of this tool .
 Object getInSurfaceRaster()
          Returns the Input surface raster parameter of this tool .
 Object getOutDropRaster()
          Returns the Output drop raster parameter of this tool .
 Object getOutFlowDirectionRaster()
          Returns the Output flow direction 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 setForceFlow(String forceFlow)
          Sets the Force all edge cells to flow outward parameter of this tool .
 void setInSurfaceRaster(Object inSurfaceRaster)
          Sets the Input surface raster parameter of this tool .
 void setOutDropRaster(Object outDropRaster)
          Sets the Output drop raster parameter of this tool .
 void setOutFlowDirectionRaster(Object outFlowDirectionRaster)
          Sets the Output flow direction 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

FlowDirection

public FlowDirection()
Creates the Flow Direction tool with defaults.

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


FlowDirection

public FlowDirection(Object inSurfaceRaster,
                     Object outFlowDirectionRaster)
Creates the Flow Direction 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:
inSurfaceRaster - Composite Geodataset, the input raster representing a continuous surface.
outFlowDirectionRaster - Raster Dataset, the output raster that shows the flow direction from each cell to its steepest downslope neighbor.
Method Detail

getInSurfaceRaster

public Object getInSurfaceRaster()
Returns the Input surface raster parameter of this tool . This parameter is Composite Geodataset, the input raster representing a continuous surface. This is a required parameter.

Returns:
the Input surface raster

setInSurfaceRaster

public void setInSurfaceRaster(Object inSurfaceRaster)
Sets the Input surface raster parameter of this tool . This parameter is Composite Geodataset, the input raster representing a continuous surface. This is a required parameter.

Parameters:
inSurfaceRaster - Composite Geodataset, the input raster representing a continuous surface.

getOutFlowDirectionRaster

public Object getOutFlowDirectionRaster()
Returns the Output flow direction raster parameter of this tool . This parameter is Raster Dataset, the output raster that shows the flow direction from each cell to its steepest downslope neighbor. This is a required parameter.

Returns:
the Output flow direction raster

setOutFlowDirectionRaster

public void setOutFlowDirectionRaster(Object outFlowDirectionRaster)
Sets the Output flow direction raster parameter of this tool . This parameter is Raster Dataset, the output raster that shows the flow direction from each cell to its steepest downslope neighbor. This is a required parameter.

Parameters:
outFlowDirectionRaster - Raster Dataset, the output raster that shows the flow direction from each cell to its steepest downslope neighbor.

getForceFlow

public String getForceFlow()
Returns the Force all edge cells to flow outward parameter of this tool . This parameter is String, specifies if edge cells will always flow outward or follow normal flow rules. This is an optional parameter.

Returns:
the Force all edge cells to flow outward

setForceFlow

public void setForceFlow(String forceFlow)
Sets the Force all edge cells to flow outward parameter of this tool . This parameter is String, specifies if edge cells will always flow outward or follow normal flow rules. This is an optional parameter.

Parameters:
forceFlow - String, specifies if edge cells will always flow outward or follow normal flow rules.

getOutDropRaster

public Object getOutDropRaster()
Returns the Output drop raster parameter of this tool . This parameter is Raster Dataset, the drop raster shows the ratio of the maximum change in elevation from each cell along the direction of flow to the path length between centers of cells, expressed in percentages. This is an optional parameter.

Returns:
the Output drop raster

setOutDropRaster

public void setOutDropRaster(Object outDropRaster)
Sets the Output drop raster parameter of this tool . This parameter is Raster Dataset, the drop raster shows the ratio of the maximum change in elevation from each cell along the direction of flow to the path length between centers of cells, expressed in percentages. This is an optional parameter.

Parameters:
outDropRaster - Raster Dataset, the drop raster shows the ratio of the maximum change in elevation from each cell along the direction of flow to the path length between centers of cells, expressed in percentages.

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