distance_to_road: Distance to the nearest road in meters

In tabrasel/WetlandTools: General utility functions for TerrainWorks

Distance to the nearest road in meters

Description

Provide a SpatRaster giving the distance to the nearest road for each cell of a DEM.

Usage

distance_to_road(
  input_file = "nofile",
  raster = "nofile",
  dem = "none",
  road_shapefile = "nofile",
  radius = 0,
  scratch_dir = "none"
)

Arguments

input_file	Character string: a "partial" input file (optional). If no input file is specified and no other arguments are present, a Windows Explorer window opens for file selection.
raster	Character string: file name (full path) for an existing contributing-area raster to read from disk (optional).
dem	Character string: The file name (full path) of the dem (elevation raster) for construction of an input file.
road_shapefile	Character string: The file name (full path) to a polyline shapefile for roads.
radius	double: Distance in meters to extend the search for a road.
scratch_dir	Character string: A scratch directory where temporary files are written. If an input file for program partial is created, it is written here.

Details

distance_to_road() operates in one of three modes, depending on the input arguments:

1. As a wrapper for the Fortran "distanceToRoad" executable, with an existing "distanceToRoad" input_file.

2. As a wrapper for program distanceToRoad, but with the input file constructed by distance_to_road.

3. To read existing raster files from disk.

In modes 1 and 2, distance_to_road calls program distanceToRoad, which creates the requested rasters and writes them to disk as floating point binary files. These are then read and returned by distance_to_road as a SpatRaster object. In mode 3, existing raster files are read directly from disk and returned as a SpatRaster object.

Value

A SpatRaster of distance to the closest road for each DEM grid point.

tabrasel/WetlandTools documentation built on Dec. 20, 2024, 8:50 a.m.