xdem.DEM.to_vcrs

Contents

xdem.DEM.to_vcrs#

DEM.to_vcrs(vcrs, force_source_vcrs=None, inplace=False)[source]#
Overloads:

  • self, vcrs (Literal[‘Ellipsoid’, ‘EGM08’, ‘EGM96’] | str | pathlib.Path | VerticalCRS | int), force_source_vcrs (Literal[‘Ellipsoid’, ‘EGM08’, ‘EGM96’] | str | pathlib.Path | VerticalCRS | int | None), inplace (Literal[False]) → DEM

  • self, vcrs (Literal[‘Ellipsoid’, ‘EGM08’, ‘EGM96’] | str | pathlib.Path | VerticalCRS | int), force_source_vcrs (Literal[‘Ellipsoid’, ‘EGM08’, ‘EGM96’] | str | pathlib.Path | VerticalCRS | int | None), inplace (Literal[True]) → None

  • self, vcrs (Literal[‘Ellipsoid’, ‘EGM08’, ‘EGM96’] | str | pathlib.Path | VerticalCRS | int), force_source_vcrs (Literal[‘Ellipsoid’, ‘EGM08’, ‘EGM96’] | str | pathlib.Path | VerticalCRS | int | None), inplace (bool) → DEM | None

Convert the DEM to another vertical coordinate reference system.

Parameters:

  • vcrs (Literal['Ellipsoid', 'EGM08', 'EGM96'] | str | Path | VerticalCRS | int) – Destination vertical CRS. Either as a name (“WGS84”, “EGM08”, “EGM96”), an EPSG code or pyproj.crs.VerticalCRS, or a path to a PROJ grid file (OSGeo/PROJ-data)

  • force_source_vcrs (Literal['Ellipsoid', 'EGM08', 'EGM96'] | str | Path | VerticalCRS | int | None) – Force a source vertical CRS (uses metadata by default). Same formats as for vcrs.

  • inplace (bool) – Whether to return a new DEM (default) or the same DEM updated in-place.

Returns:

DEM with vertical reference transformed, or None.

Contents