Ctrl+K

xdem.DEM.coregister_3d

xdem.DEM.coregister_3d#

DEM.coregister_3d(reference_elev, coreg_method=None, inlier_mask=None, bias_vars=None, **kwargs)[source]#

Coregister DEM to a reference DEM in three dimensions.

Any coregistration method or pipeline from xdem.Coreg can be passed. Default is only horizontal and vertical shifts of Nuth and Kääb (2011).

Parameters:

  • reference_elev (DEM | GeoDataFrame) – Reference elevation, DEM or elevation point cloud, for the alignment.

  • coreg_method (Coreg) – Coregistration method or pipeline.

  • inlier_mask (Mask | ndarray[Any, dtype[bool_]]) – Optional. 2D boolean array or mask of areas to include in the analysis (inliers=True).

  • bias_vars (dict[str, Union[ndarray[Any, dtype[floating[Any]]], MaskedArray[Any, dtype[floating[Any]]], TypeVar(RasterType, bound= Raster)]]) – Optional, only for some bias correction methods. 2D array or rasters of bias variables used.

  • kwargs (Any) – Keyword arguments passed to Coreg.fit().

Return type:

DEM

Returns:

Coregistered DEM.

Contents