Skip to contents

Distance to access layer

Source: R/calculate_distance.R
calculate_distance.Rd

Per pixel distance to nearest access vector. Intended to be used as a `cost` constraint within the sample_clhs function

Usage

calculate_distance(
  raster,
  access,
  slope = FALSE,
  plot = FALSE,
  filename = NULL,
  overwrite = FALSE
)

Arguments

raster

spatRaster. Raster to be used to calculate pixel level distance to access layer.

access

sf 'LINESTRING' or 'MULTILINESTRING'. Access network.

slope

Logical. Calculate slope distance instead of geographic distance. raster needs to be a digital terrain model for this to make sense.

plot

Logical. Plots output strata raster with samples.

filename

Character. Path to write output samples.

overwrite

Logical. Choice to overwrite existing filename if it exists.

Value

Input raster with dist2access layer appended.

See also

Other calculate functions: calculate_allocation(), calculate_allocation_existing(), calculate_coobs(), calculate_pcomp(), calculate_pop(), calculate_representation(), calculate_sampsize()

Author

Tristan R.H. Goodbody

Examples

if (FALSE) {
#--- Load raster and access files ---#
r <- system.file("extdata", "mraster_small.tif", package = "sgsR")
mr <- terra::rast(r)

a <- system.file("extdata", "access.shp", package = "sgsR")
ac <- sf::st_read(a)

calculate_distance(
  raster = mr,
  access = ac,
)
}