Ctrl+K

xdem.coreg.Coreg.apply

Contents

xdem.coreg.Coreg.apply#

Coreg.apply(elev, bias_vars=None, resample=True, resampling='bilinear', transform=None, crs=None, z_name='z', **kwargs)[source]#

Apply the estimated transform to a DEM.

Parameters:

  • elev (Union[ndarray[Any, dtype[floating[Any]]], MaskedArray[Any, dtype[floating[Any]]], TypeVar(RasterType, bound= Raster), GeoDataFrame]) – Elevation to apply the transform to, either a DEM or an elevation point cloud.

  • bias_vars (dict[str, Union[ndarray[Any, dtype[floating[Any]]], MaskedArray[Any, dtype[floating[Any]]], TypeVar(RasterType, bound= Raster)]] | None) – Only for some bias correction classes. 2D array of bias variables used.

  • resample (bool) – If set to True, will reproject output Raster on the same grid as input. Otherwise, only the transform might be updated and no resampling is done.

  • resampling (str | Resampling) – Resampling method if resample is used. Defaults to “bilinear”.

  • transform (Affine | None) – Geotransform of the elevation, only if provided as 2D array.

  • crs (CRS | None) – CRS of elevation, only if provided as 2D array.

  • z_name (str) – Column name to use as elevation, only for point elevation data passed as geodataframe.

  • kwargs (Any) – Any optional arguments to be passed to either self._apply_rst or apply_matrix.

Return type:

Union[TypeVar(RasterType, bound= Raster), GeoDataFrame, tuple[ndarray[Any, dtype[floating[Any]]], Affine], tuple[MaskedArray[Any, dtype[floating[Any]]], Affine]]

Returns:

The transformed DEM.

Contents