Euclidean Distance (Spatial Analyst)

License Level:BasicStandardAdvanced

Summary

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

Learn more about Euclidean distance analysis

Illustration

Euclidean Distance illustration
Euc_Dist = EucDistance(Source_Ras)

Usage

Syntax

EucDistance (in_source_data, {maximum_distance}, {cell_size}, {out_direction_raster})
ParameterExplanationData Type
in_source_data

The input source locations.

This is a raster or feature dataset that identifies the cells or locations to which the Euclidean distance for every output cell location is calculated.

For rasters, the input type can be integer or floating point.

Raster Layer | Feature Layer
maximum_distance
(Optional)

Defines the threshold that the accumulative distance values cannot exceed.

If an accumulative Euclidean distance value exceeds this value, the output value for the cell location will be NoData.

The default distance is to the edge of the output raster.

Double
cell_size
(Optional)

The cell size at which the output raster will be created.

This will be the value in the environment if it is explicitly set. If it is not set in the environment, the default cell size will depend on if the input source data is a raster or a feature, as follows:

  • If the source is raster, the output will have that same cell size.
  • If the source is feature, the output will have a cell size determined by the shorter of the width or height of the extent of input feature, in the input spatial reference, divided by 250.

Analysis Cell Size
out_direction_raster
(Optional)

The output Euclidean direction raster.

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 degrees to 360 degrees, with 0 reserved for the source cells. Due east (right) is 90, and the values increase clockwise (180 is south, 270 is west, and 360 is north).

The output raster is of integer type.

Raster Dataset

Return Value

NameExplanationData Type
out_distance_raster

The output Euclidean distance raster.

The distance raster identifies, for each cell, the Euclidean distance to the closest source cell, set of source cells, or source location.

The output raster is of floating point type.

Raster

Code Sample

EucDistance example 1 (Python window)

The following Python Window script demonstrates how to use the EuclideanDistance tool.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outEucDistance = EucDistance("rec_sites.shp", 5000, 5, 
                             "c:/sapyexamples/output/EucDirOut")
outEucDistance.save("C:/sapyexamples/output/eucdist")
EucDistance example 2 (stand-alone script)

Calculates for each cell the straight line distance to the nearest source.

# Name: EucDistance_Ex_02.py
# Description: Calculates for each cell the Euclidean distance to the nearest source.
# Requirements: Spatial Analyst Extension

# Import system modules
import arcpy
from arcpy import env
from arcpy.sa import *

# Set environment settings
env.workspace = "C:/sapyexamples/data"

# Set local variables
inSourceData = "rec_sites.shp"
maxDistance = 4000
cellSize = 4
outDirectionRaster = "C:/sapyexamples/output/eucdirect"

# Check out the ArcGIS Spatial Analyst extension license
arcpy.CheckOutExtension("Spatial")

# Execute EucDistance
outEucDistance = EucDistance(inSourceData, maxDistance, cellSize, outDirectionRaster)

# Save the output 
outEucDistance.save("C:/sapyexamples/output/eucdist")

Environments

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Requires Spatial Analyst
ArcGIS for Desktop Standard: Requires Spatial Analyst
ArcGIS for Desktop Advanced: Requires Spatial Analyst
4/10/2014