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


IDistanceOp.CostPathAsPolyline Method (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > SpatialAnalyst > ESRI.ArcGIS.SpatialAnalyst > Interfaces > ID > IDistanceOp Interface > IDistanceOp.CostPathAsPolyline Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

IDistanceOp.CostPathAsPolyline Method

Calculates the least-cost path(s) from selected points in the input data and returns it as a polyline.

[Visual Basic .NET]
Public Function CostPathAsPolyline ( _
    ByVal sourcePoints As IPointCollection, _
    ByVal distance As IGeoDataset, _
    ByVal backlink As IGeoDataset _
) As IGeometryCollection

[C#]
public IGeometryCollection CostPathAsPolyline (
    IPointCollection sourcePoints,
    IGeoDataset distance,
    IGeoDataset backlink
);

[C++]
HRESULT CostPathAsPolyline(
  IPointCollection* sourcePoints,
  IGeoDataset* distance,
  IGeoDataset* backlink,
  IGeometryCollection** CostPath
);

[C++]

Parameters
sourcePoints [in]

  sourcePoints is a parameter of type IPointCollection
distance [in]

  distance is a parameter of type IGeoDataset
backlink [in]

  backlink is a parameter of type IGeoDataset
CostPath [out, retval]

  CostPath is a parameter of type IGeometryCollection

Product Availability

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

Remarks

sourcePoints

input collection of points which identifies the destinations in which the least cost path is routed to

distance

the name of a cost distance Raster to be used to determine the least cost path from the fromRaster cell locations to a source.

The distance Raster is usually created with the IDistanceOp::CostDistance method (or by the IDistanceOp::CostDistanceFull method). The distance Raster stores, for each cell, the minimum accumulative cost distance over a cost surface from each cell to a set of source cells.

backlink

the name of a cost back link Raster used to determine the path to return to a source via the least-cost path

For each cell in the back link raster, a value identifies the neighbor that is the next cell on the least accumulative cost path from the cell to a single or set of source cells.

 

See Also

IDistanceOp Interface