This document is archived and information here might be outdated.  Recommended version.


INeighborhoodOp.FocalFlow Method (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > SpatialAnalyst > ESRI.ArcGIS.SpatialAnalyst > Interfaces > IN > INeighborhoodOp Interface > INeighborhoodOp.FocalFlow Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

INeighborhoodOp.FocalFlow Method

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
);
[C#]

Optional Values

thresholdValue   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing. 
[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 VARIANT

  To 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

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

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.

 

See Also

INeighborhoodOp Interface