xdem.DEM.fractal_roughness

xdem.DEM.fractal_roughness#

DEM.fractal_roughness(window_size=13, mp_config=None)[source]#

Calculates the fractal roughness, the local 3D fractal dimension. Can only be computed on window sizes larger or equal to 5x5, defaults to 13x13. Output unit is a fractal dimension between 1 and 3.

Based on: Taud et Parrot (2005), https://doi.org/10.4000/geomorphologie.622.

Parameters:

  • 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)