Calculates the Euclidean distance from a single source or set of sources.
One example application of this tool is finding the distance from any location to the closest town.
The input source data can be a feature service, an image service or a portal item.
When the input source data is an image service, the set of source cells consists of all cells in the source raster that have valid values. Cells that have NoData values are not included in the source set. The value 0 is considered a legitimate source.
When the input source data is a feature service, the source locations are converted internally to a raster before performing the analysis. The resolution of the raster can be controlled with the Output cell size parameter or the Cell Size environment. By default, the resolution will be determined by the shorter of the width or height of the extent of input feature, in the input spatial reference, divided by 250.
| Parameter | Explanation |
|---|---|
| inputSourceRasterOrFeatures |
The layer that defines the sources to calculate the distance to. The layer can be image service or feature service. For image service, the input type can be integer or floating point. For feature service, the input can be point, line or polygon. |
| outputDistanceName |
The name of the output distance raster service. |
| maximumDistance (Optional) |
The maximum distance to calculate out to. The units can be Kilometers, Meters, Miles, Yards, or Feet. The default units are Meters. |
| outputCellSize (Optional) |
Set the cell size and units for the output raster. The units can be Kilometers, Meters, Miles, Yards, or Feet. The default units are Meters. |
| outputDirectionName (Optional) |
The name of the output direction raster service. |
| outputAllocationName (Optional) |
The name of the output allocation raster service. |
| allocationField (Optional) |
A field on the source input that holds the values that define each source. It must be of type integer. |
| distanceMethod (Optional) |
Specifies whether to calculate the distance using a planar (flat earth) or a geodesic (ellipsoid) method. Planar—The distance calculation will be performed on a projected flat plane using a 2D Cartesian coordinate system. This is the default.Geodesic—The distance calculation will be performed on the ellipsoid. Therefore, regardless of input or output projection, the results do not change. |
| inputBarrierRasterOrFeatures (Optional) |
Dataset that defines the barriers. The barriers can be defined by an integer or floating point raster, or a feature layer. |
| outputBackDirectionName (Optional) |
The name of the output back direction raster service. |
| context (Optional) |
There is no explanation for this parameter. |
CalculateDistance example 1 (Python window)
This example calculates the Euclidean distance from a single source.
import arcpy
arcpy.CalculateDistance_ra('https://MyPortal.esri.com/server/rest/services/Hosted/myPoints/FeatureServer/0',
"outDistance", "5000", "10", "outDirection", "outAllocation", "siting")
CalculateDistance example 2 (stand-alone script)
This example calculates the Euclidean distance from a set of sources.
# Name: CalculateDistance_Ex_02.py
# Description: Calculates for each cell the Euclidean distance, direction and allocation
# to the nearest source.
# Requirements: ArcGIS Image Server
# Import system modules
import arcpy
# Set local variables
inSourceData = 'https://MyPortal.esri.com/server/rest/services/Hosted/reccenter/ImageServer'
outDistanceName = "eucdistance"
maxDistance = "4000"
cellSize = "10"
outDirectionName = "eucdirect"
outAllocationName = "eurallocation"
allocationField = "dataid"
# Execute EucDistance
arcpy.CalculateDistance_ra(inSourceData, outDistanceName, maxDistance, cellSize, outDirectionName,
outAllocationName, allocationField)
There are no tags for this item.
There are no credits for this item.
There are no use limitations for this item.