xrspatial.proximity.euclidean_distance#

xrspatial.proximity.euclidean_distance(x1: float, x2: float, y1: float, y2: float) → float[source]#

Calculates Euclidean (straight line) distance between (x1, y1) and (x2, y2).

Parameters

x1 (float) – x-coordinate of the first point.
x2 (float) – x-coordinate of the second point.
y1 (float) – y-coordinate of the first point.
y2 (float) – y-coordinate of the second point.

Returns

distance – Euclidean distance between two points.

Return type

float

References

Wikipedia: https://en.wikipedia.org/wiki/Euclidean_distance#:~:text=In%20mathematics%2C%20the%20Euclidean%20distance,being%20called%20the%20Pythagorean%20distance. # noqa

Examples

>>> # Imports
>>> from xrspatial import euclidean_distance
>>> point_a = (142.32, 23.23)
>>> point_b = (312.54, 432.01)
>>> # Calculate Euclidean Distance
>>> dist = euclidean_distance(
...     point_a[0],
...     point_b[0],
...     point_a[1],
...     point_b[1])
>>> print(dist)
442.80462599209596