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 );
Optional Values
[C++]
HRESULT EucDistance(
IGeoDataset* sourceData,
VARIANT* maxDistance,
VARIANT* valueRaster,
IGeoDataset** distance
);
[C++]Parameters
sourceData [in]sourceData is a parameter of type IGeoDataset
maxDistance [optional] maxDistance is a parameter of type VARIANTTo 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 VARIANTTo indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.
distance [out, retval]distance is a parameter of type IGeoDataset
Product Availability
Remarks
sourceData |
an input Raster, RasterDataset, RasterBand, or RasterDescriptor or FeatureClass, FeatureClassDescriptor 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 of type Raster, RasterDataset, RasterBand, or RasterDescriptor. |
- The method returns a reference to a Raster object.
- Read the Working with ArcGIS Spatial Analyst objects technical document for general information on implementing Spatial Analyst operations.