xdem.DEM.coregister_3d#
- DEM.coregister_3d(reference_elev, coreg_method, inlier_mask=None, bias_vars=None, random_state=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|EPC) – Reference elevation, DEM or elevation point cloud, for the alignment.coreg_method (
Coreg) – Coregistration method or pipeline.inlier_mask (
Raster|ndarray[tuple[Any,...],dtype[bool]]) – Optional. 2D boolean array or mask of areas to include in the analysis (inliers=True).bias_vars (
dict[str,ndarray[tuple[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.random_state (
int|Generator|None) – Random state or seed number to use for subsampling and optimizer.resample – If set to True, will reproject output Raster on the same grid as input. Otherwise, only the array/transform will be updated (if possible) and no resampling is done. Useful to avoid spreading data gaps.
kwargs – Keyword arguments passed to Coreg.fit().
- Return type:
- Returns:
Coregistered DEM