Calculates the flow of the values in the surface within each cells immediate neighborhood.
[Visual Basic .NET] Public Function FocalFlow ( _ ByVal geoDataset As IGeoDataset, _ [ByRef thresholdValue As Object] _ ) As IGeoDataset
[C#] public IGeoDataset FocalFlow ( IGeoDataset geoDataset, ref object thresholdValue );
Optional Values
[C++]
HRESULT FocalFlow(
IGeoDataset* geoDataset,
VARIANT* thresholdValue,
IGeoDataset** outGeodataset
);
[C++]Parameters
geoDataset [in]geoDataset is a parameter of type IGeoDataset
thresholdValue [optional] thresholdValue is a parameter of type VARIANTTo indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.
outGeodataset [out, retval]outGeodataset is a parameter of type IGeoDataset
Product Availability
Remarks
geoDataset |
an input integer or floating-point grid that identifies the values of the focal or processing cell and the values of the cells in its specified neighborhood INeighborhood::FocalFlow evaluates the eight immediate neighbors of a cell to determine flow. |
[thresholdValue] |
defines a value that constitutes the threshold, which must be equalled or exceeded before flow can occur 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 ‘0’ (or no flow). The data type for thresholdValue can be either integer or floating point. |
- The method returns a reference to a Raster object.
- Read the Working with ArcGIS Spatial Analyst objects technical document for general information on implementing Spatial Analyst operations