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=None, **kwargs)[source]#
Overloads:

  • self, elev (MArrayf), bias_vars (dict[str, NDArrayf | MArrayf | RasterType] | None), resample (bool), resampling (str | rio.warp.Resampling), transform (rio.transform.Affine | None), crs (rio.crs.CRS | None), z_name (str | None), kwargs (Any) → tuple[MArrayf, rio.transform.Affine]

  • self, elev (NDArrayf), bias_vars (dict[str, NDArrayf | MArrayf | RasterType] | None), resample (bool), resampling (str | rio.warp.Resampling), transform (rio.transform.Affine | None), crs (rio.crs.CRS | None), z_name (str | None), kwargs (Any) → tuple[NDArrayf, rio.transform.Affine]

  • self, elev (RasterType | gpd.GeoDataFrame | PointCloudType), bias_vars (dict[str, NDArrayf | MArrayf | RasterType] | None), resample (bool), resampling (str | rio.warp.Resampling), transform (rio.transform.Affine | None), crs (rio.crs.CRS | None), z_name (str | None), kwargs (Any) → RasterType | gpd.GeoDataFrame | PointCloudType

Apply the estimated transform to a DEM.

Parameters:

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

  • bias_vars (dict[str, ndarray[tuple[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 | None) – 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.

Returns:

The transformed DEM.

Contents