|
|||||||||
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.FocalFlow
public class FocalFlow
Determines the flow of the values in the input raster within each cell's immediate neighborhood. The Focal Flow tool is contained in the Spatial Analyst Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
FocalFlow()
Creates the Focal Flow tool with defaults. |
|
FocalFlow(Object inSurfaceRaster,
Object outRaster)
Creates the Focal Flow tool with the required parameters. |
Method Summary | |
---|---|
Object |
getInSurfaceRaster()
Returns the Input surface raster parameter of this tool . |
Object |
getOutRaster()
Returns the Output raster parameter of this tool . |
double |
getThresholdValue()
Returns the Threshold value 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 |
setInSurfaceRaster(Object inSurfaceRaster)
Sets the Input surface raster parameter of this tool . |
void |
setOutRaster(Object outRaster)
Sets the Output raster parameter of this tool . |
void |
setThresholdValue(double thresholdValue)
Sets the Threshold value 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 FocalFlow()
Initializes the array of tool parameters with the default values specified when the tool was created.
public FocalFlow(Object inSurfaceRaster, Object outRaster)
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 surface raster for which to calculate the focal flow. the eight immediate neighbors of each cell are evaluated to determine the flow. the input raster can be integer or floating point.outRaster
- the output focal flow raster. the output raster is always of integer type.Method Detail |
---|
public Object getInSurfaceRaster()
public void setInSurfaceRaster(Object inSurfaceRaster)
inSurfaceRaster
- the input surface raster for which to calculate the focal flow. the eight immediate neighbors of each cell are evaluated to determine the flow. the input raster can be integer or floating point.public Object getOutRaster()
public void setOutRaster(Object outRaster)
outRaster
- the output focal flow raster. the output raster is always of integer type.public double getThresholdValue()
public void setThresholdValue(double thresholdValue)
thresholdValue
- defines a value that constitutes the threshold, which must be equaled or exceeded before flow can occur. the threshold value can be either an integer or floating-point value. if the difference between the value at a neighboring cell location and the value of the processing cell is less than or equal to the threshold value, the output will be zero (or no flow).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 |