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


IDistanceOp2.EucDistanceFull Method (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > SpatialAnalyst > ESRI.ArcGIS.SpatialAnalyst > Interfaces > ID > IDistanceOp2 Interface > IDistanceOp2.EucDistanceFull Method (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

IDistanceOp2.EucDistanceFull Method

Calculates for each cell optionally the Euclidean distance, direction, and allocation to the closest source.

[Visual Basic .NET]
Public Function EucDistanceFull ( _
    ByVal sourceData As IGeoDataset, _
    ByVal distance As Boolean, _
    ByVal direction As Boolean, _
    ByVal allocation As Boolean, _
    [ByRef maxDistance As Object], _
    [ByRef valueRaster As Object] _
) As IGeoDataset

[C#]
public IGeoDataset EucDistanceFull (
    IGeoDataset sourceData,
    bool distance,
    bool direction,
    bool allocation,
    ref object maxDistance,
    ref object valueRaster
);
[C#]

Optional Values

maxDistance   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
valueRaster   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing. 
[C++]
HRESULT EucDistanceFull(
  IGeoDataset* sourceData,
  VARIANT_BOOL distance,
  VARIANT_BOOL direction,
  VARIANT_BOOL allocation,
  VARIANT* maxDistance,
  VARIANT* valueRaster,
  IGeoDataset** outData
);

[C++]

Parameters
sourceData [in]

  sourceData is a parameter of type IGeoDataset
distance [in]
  distance is a parameter of type VARIANT_BOOL
direction [in]
  direction is a parameter of type VARIANT_BOOL
allocation [in]
  allocation is a parameter of type VARIANT_BOOL
maxDistance [optional]
  maxDistance 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.
valueRaster [optional]
  valueRaster 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.
outData [out, retval]

  outData is a parameter of type IGeoDataset

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.

[distance]

A Boolean and if True an output (Euclidean) distance Raster will be created. The distance Raster calculates for each cell the Euclidean distance to the closest source.

[direction]

a Boolean and if True an output (Euclidean) direction Raster will be created. The direction Raster contains the calculated direction in degrees each cell center is from the closest source cell center. The range of values is from 0° to 360°, with ‘0’ being reserved for the source cells. Due east (right) is 90 and the values increase clockwise (180, south; 270, west; and 360, north).

[allocation]

A Boolean and if True an output (Euclidean) allocation Raster will be created. For each cell, the allocation Raster identifies the zone of the closest source cell (in Euclidean distance)..

[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