extract_lsm: extract_lsm

In landscapemetrics: Landscape Metrics for Categorical Map Patterns

extract_lsm

Description

Extract metrics

Usage

extract_lsm(
  landscape,
  y,
  extract_id = NULL,
  metric = NULL,
  name = NULL,
  type = NULL,
  what = NULL,
  directions = 8,
  progress = FALSE,
  verbose = TRUE,
  ...
)

Arguments

landscape	A categorical raster object: SpatRaster; Raster* Layer, Stack, Brick; stars or a list of SpatRasters.
y	Point geometry as SpatVector or sf object or 2-column matrix with coordinates.
extract_id	Vector with id of sample points. If not provided, sample points will be labelled 1...n.
metric	Abbreviation of metrics (e.g. 'area').
name	Full name of metrics (e.g. 'core area')
type	Type according to FRAGSTATS grouping (e.g. 'aggregation metrics').
what	Selected level of metrics: either "patch", "class" or "landscape". It is also possible to specify functions as a vector of strings, e.g. what = c("lsm_c_ca", "lsm_l_ta").
directions	The number of directions in which patches should be connected: 4 (rook's case) or 8 (queen's case).
progress	Print progress report.
verbose	Print warning messages.
...	Arguments passed to calculate_lsm().

Details

This functions extracts the metrics of all patches the spatial object(s) y (e.g. spatial points) are located within. Only patch level metrics are possible to extract. Please be aware that the output is slightly different to all other lsm-function of landscapemetrics. Returns a tibble with chosen metrics and the ID of the spatial objects.

Value

tibble

See Also

calculate_lsm

Examples

landscape <- terra::rast(landscapemetrics::landscape)

points <- matrix(c(10, 5, 25, 15, 5, 25), ncol = 2, byrow = TRUE)
extract_lsm(landscape, y = points)
extract_lsm(landscape, y = points, type = "aggregation metric")

## Not run: 
# use lines


## End(Not run)

landscapemetrics documentation built on April 4, 2025, 2:17 a.m.