get_nearestneighbour: get_nearestneighbour

Description Usage Arguments Details References Examples

View source: R/get_nearestneighbour.R

Description

Euclidean distance to nearest neighbour

Usage

1

Arguments

landscape

RasterLayer or matrix (with x,y,id columns).

return_id

If TRUE, also the patch ID of the nearest neighbour is returned.

Details

Fast and memory safe Rcpp implementation for calculating the minimum Euclidean distances to the nearest patch of the same class in a raster or matrix. All patches need an unique ID (see get_patches). Please be aware that the patch ID is not identical to the patch ID of all metric functions (lsm_). If return_ID = TRUE, for some focal patches several nearest neighbour patches might be returned.

References

Based on RCpp code of Florian Privé florian.prive.21@gmail.com

Examples

1
2
3
4
5
6
# get patches for class 1
class_1 <- get_patches(landscape, class = 2)[[1]][[1]]

# calculate the distance between patches
get_nearestneighbour(class_1)
get_nearestneighbour(class_1, return_id = TRUE)

landscapemetrics documentation built on Sept. 5, 2021, 5:20 p.m.