|
|||||||||
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.FlowAccumulation
public class FlowAccumulation
Creates a raster of accumulated flow into each cell. A weight factor can optionally be applied. The Flow Accumulation tool is contained in the Spatial Analyst Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
FlowAccumulation()
Creates the Flow Accumulation tool with defaults. |
|
FlowAccumulation(Object inFlowDirectionRaster,
Object outAccumulationRaster)
Creates the Flow Accumulation tool with the required parameters. |
Method Summary | |
---|---|
String |
getDataType()
Returns the Output data type parameter of this tool . |
Object |
getInFlowDirectionRaster()
Returns the Input flow direction raster parameter of this tool . |
Object |
getInWeightRaster()
Returns the Input weight raster parameter of this tool . |
Object |
getOutAccumulationRaster()
Returns the Output accumulation 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 |
setDataType(String dataType)
Sets the Output data type parameter of this tool . |
void |
setInFlowDirectionRaster(Object inFlowDirectionRaster)
Sets the Input flow direction raster parameter of this tool . |
void |
setInWeightRaster(Object inWeightRaster)
Sets the Input weight raster parameter of this tool . |
void |
setOutAccumulationRaster(Object outAccumulationRaster)
Sets the Output accumulation 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 FlowAccumulation()
Initializes the array of tool parameters with the default values specified when the tool was created.
public FlowAccumulation(Object inFlowDirectionRaster, Object outAccumulationRaster)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other 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.outAccumulationRaster
- the output raster that shows the accumulated flow to each cell.Method Detail |
---|
public Object getInFlowDirectionRaster()
public void setInFlowDirectionRaster(Object inFlowDirectionRaster)
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.public Object getOutAccumulationRaster()
public void setOutAccumulationRaster(Object outAccumulationRaster)
outAccumulationRaster
- the output raster that shows the accumulated flow to each cell.public Object getInWeightRaster()
public void setInWeightRaster(Object inWeightRaster)
inWeightRaster
- an optional input raster for applying a weight to each cell. if no weight raster is specified, a default weight of 1 will be applied to each cell. For each cell in the output raster, the result will be the number of cells that flow into it.public String getDataType()
public void setDataType(String dataType)
dataType
- the output accumulation raster can be integer or floating point type.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 |