xrspatial.surface_distance.surface_direction#
- xrspatial.surface_distance.surface_direction(raster: DataArray, elevation: DataArray, x: str = 'x', y: str = 'y', target_values: list = [], max_distance: float = inf, connectivity: int = 8, method: str = 'planar') DataArray[source]#
Compute compass direction to nearest target along terrain surface.
For each pixel, returns the compass direction (in degrees) to the nearest target pixel by surface distance. 0 = source pixel, 90 = east, 180 = south, 270 = west, 360 = north.
- Parameters:
raster (xr.DataArray or xr.Dataset) – 2-D source raster with target pixels.
elevation (xr.DataArray) – 2-D elevation surface (same shape as raster).
x – See
surface_distance().y – See
surface_distance().target_values – See
surface_distance().max_distance – See
surface_distance().connectivity – See
surface_distance().method – See
surface_distance().
- Returns:
2-D array of direction values (float32, degrees).
- Return type:
xr.DataArray or xr.Dataset