xdem.DEM.terrain_ruggedness_index#
- DEM.terrain_ruggedness_index(method='Riley', window_size=3, mp_config=None)[source]#
Calculates the Terrain Ruggedness Index, the cumulated differences to neighbouring pixels. Output is in the unit of the DEM (typically meters).
Based either on:
- Riley et al. (1999), http://download.osgeo.org/qgis/doc/reference-docs/Terrain_Ruggedness_Index.pdf that derives
the squareroot of squared differences to neighbouring pixels, preferred for topography.
- Wilson et al. (2007), http://dx.doi.org/10.1080/01490410701295962 that derives the mean absolute difference to
neighbouring pixels, preferred for bathymetry.
- Parameters:
method (
Literal['Riley','Wilson']) – The algorithm used (“Riley” for topography or “Wilson” for bathymetry).window_size (
int) – The size of the window for deriving the metric.mp_config (
MultiprocConfig|None) – Multiprocessing configuration, run the function in multiprocessing if not None.engine – Engine to use for computing the attribute, “scipy” or “numba”.
- Raises:
ValueError – If the inputs are poorly formatted.
- Return type:
TypeVar(RasterType, bound= Raster)