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


IHydrologyOp.SnapPourPoint Method (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > SpatialAnalyst > ESRI.ArcGIS.SpatialAnalyst > Interfaces > IH > IHydrologyOp Interface > IHydrologyOp.SnapPourPoint Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

IHydrologyOp.SnapPourPoint Method

Snaps selected pour points to the cell of highest flow accumulation within a specified distance.

[Visual Basic .NET]
Public Function SnapPourPoint ( _
    ByVal sourceDataset As IGeoDataset, _
    ByVal accumulationRaster As IGeoDataset, _
    ByVal snapDistance As Double _
) As IGeoDataset

[C#]
public IGeoDataset SnapPourPoint (
    IGeoDataset sourceDataset,
    IGeoDataset accumulationRaster,
    double snapDistance
);

[C++]
HRESULT SnapPourPoint(
  IGeoDataset* sourceDataset,
  IGeoDataset* accumulationRaster,
  double snapDistance,
  IGeoDataset** SnapPourPoint
);

[C++]

Parameters
sourceDataset [in]

  sourceDataset is a parameter of type IGeoDataset
accumulationRaster [in]

  accumulationRaster is a parameter of type IGeoDataset
snapDistance [in]
  snapDistance is a parameter of type double
SnapPourPoint [out, retval]

  SnapPourPoint is a parameter of type IGeoDataset

Product Availability

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

Remarks

sourceDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor or FeatureClass, FeatureClassDescriptor of cells to be used as pour points

Cells that are not NoData will be considered pour points and will be snapped.

accumulationRaster a Raster of accumulated flow, created with the IHydrology::FlowAccumulation method.
snapDistance the maximum distance in map units, to search for a cell of higher accumulated flow

A common snap distance is zero, the same as if SnapPourPoint was not used.

 

See Also

IHydrologyOp Interface