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

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

All Implemented Interfaces:

GPTool

public class FocalFlow
extends AbstractGPTool

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.
Learn more about how Focal Flow works

Software restrictions: none

Illustration:

Usage tips:

• The output of Focal Flow is always an integer value.
• The resulting values of Focal Flow measure flow into, not out of, a cell.
• The {threshold_value} can be either an integer or floating-point value.
• The output values of a function are derived from the binary representation of the results of the analysis.
• The following environment settings affect this tool:

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

FocalFlow

public FocalFlow()

Creates the Focal Flow tool with defaults.

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

FocalFlow

public FocalFlow(Object inSurfaceRaster,
                 Object outRaster)

Creates the Focal Flow 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 can be integer or floating point.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInSurfaceRaster

public Object getInSurfaceRaster()

Returns the Input surface raster parameter of this tool . This parameter is Composite Geodataset, the input raster can be integer or floating point. 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 can be integer or floating point. This is a required parameter.

Parameters:

inSurfaceRaster - Composite Geodataset, the input raster can be integer or floating point.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the raster to be created.

getThresholdValue

public double getThresholdValue()

Returns the Threshold value parameter of this tool . This parameter is Double, 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). This is an optional parameter.

Returns:

the Threshold value

setThresholdValue

public void setThresholdValue(double thresholdValue)

Sets the Threshold value parameter of this tool . This parameter is Double, 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). This is an optional parameter.

Parameters:

thresholdValue - Double, 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).

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