roughnessIndex: Roughness Index (Surface Texture)

Description Usage Arguments Value

View source: R/roughnessIndex.R

Description

[roughnessIndex()] as standard deviation of residual topography (Cavalli et al. 2008).

Usage

1
2
roughnessIndex(elevation = NULL, size = 3, output = NULL,
  load_output = TRUE, return_weighted = FALSE, quiet = TRUE, ...)

Arguments

elevation

RasterLayer containing elevation values

output

(optional) file name to save output. If return_weighted is TRUE, output should be vector containing two file names. Default: NULL

load_output

If TRUE, function output file will be loaded into R. Default: TRUE

return_weighted

If TRUE roughness index is normalized by max-value. Default: FALSE

quiet

IF FALSE, console messages are shown. Default: TRUE

...

optional parameter for [RQGIS::run_qgis()]

Value

RasterLayer roughness index. If return_weighted is TRUE, a list is returned containing roughness index [[1]] and normalized roughness index [[2]]


raff-k/GeoMorphTB documentation built on Jan. 5, 2022, 2:08 p.m.