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


IDistanceOp2.EucDistance Method (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

IDistanceOp2.EucDistance Method

Calculates for each cell the Euclidean distance to the closest source.

[Visual Basic .NET]
Public Function EucDistance ( _
    ByVal sourceData As IGeoDataset, _
    [ByRef maxDistance As Object], _
    [ByRef valueRaster As Object] _
) As IGeoDataset

[C#]
public IGeoDataset EucDistance (
    IGeoDataset sourceData,
    ref object maxDistance,
    ref object valueRaster
);

[C++]
HRESULT EucDistance(
  IGeoDataset* sourceData,
  Variant* maxDistance,
  Variant* valueRaster
);

[C++]

Parameters
sourceData [in]

  sourceData is a parameter of type IGeoDataset*
maxDistance [in, optional]

  maxDistance is a parameter of type VARIANT*
valueRaster [in, optional]

  valueRaster is a parameter of type VARIANT*

Product Availability

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

Remarks

sourceData

a Raster or feature dataset that identifies those cells or locations whose values are assigned to the output cell locations that they are closest to. For rasters, the input value type can be an integer type, string type, or floating point type if in_value_raster is used.

[maxDistance]

Defines the threshold that the Euclidean distance values cannot exceed. If a cell is farther than the [maxDistance], the output value for the cell location will be NoData. The default distance is to the edge of the output Raster. The data type for maxDistance can be either integer or floating point.

[valueRaster]

An input Raster that identifies the values to associate with the source cell locations. The source cells define the zones that will be used in the Euclidean distance calculations. The [valueRaster] is particularly important if the source Raster was created by the ILogicalOp::Test method or a Boolean operator that will only output 1 and 0, or if alternative values or zones are to be used instead of the existing ones on the source input. The data type for the valueRaster can be any Raster object that supports IGeoDataset (e.g., Raster, Raster band, etc.).

 

See Also

IDistanceOp2 Interface