|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.spatialanalysttools.FlowDirection
public class FlowDirection
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.
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 |
---|
public FlowDirection()
Initializes the array of tool parameters with the default values specified when the tool was created.
public FlowDirection(Object inSurfaceRaster, Object outFlowDirectionRaster)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inSurfaceRaster
- the input raster representing a continuous surface.outFlowDirectionRaster
- the output raster that shows the flow direction from each cell to its steepest downslope neighbor.Method Detail |
---|
public Object getInSurfaceRaster()
public void setInSurfaceRaster(Object inSurfaceRaster)
inSurfaceRaster
- the input raster representing a continuous surface.public Object getOutFlowDirectionRaster()
public void setOutFlowDirectionRaster(Object outFlowDirectionRaster)
outFlowDirectionRaster
- the output raster that shows the flow direction from each cell to its steepest downslope neighbor.public String getForceFlow()
public void setForceFlow(String forceFlow)
forceFlow
- specifies if edge cells will always flow outward or follow normal flow rules.public Object getOutDropRaster()
public void setOutDropRaster(Object outDropRaster)
outDropRaster
- an optional output drop raster. 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.public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |