Ctrl+K

pdemtools.data module

pdemtools.data module#

This module contains functions necessary extracting relevant datasets for DEM processing (geoids, masks, etc), resampled to match the DEM xarray object.

pdemtools.data.bedrock_mask_from_bedmachine(bm_fpath: str, target_rxd: DataArray) → DataArray#

Construct boolean bedrock mask from bedmachine and a given target rioxarray dataset. Returns mask where bedrock values are 1 and outside are 0.

Parameters:

  • bm_fpath (str) – Filepath to BedMachine dataset, defaults to None

  • target_rxd (DataArray) – (rio)xarray dataset that BedMachine will be resampled to match

Returns:

bedrock mask for the target_rxd region as a (rio)xarray DataArray

Return type:

DataArray

pdemtools.data.bedrock_mask_from_vector(vector: str | GeoDataFrame, target_rxd: DataArray) → DataArray#

Construct boolean bedrock mask from a Geopandas vector file of bedrock areas and a given target rioxarray dataset. Returns mask where bedrock values are 1 and outside are 0.

Parameters:

  • vector – either a GeoPandas GeoDataFrame of bedrock areas, or a filepath to a Geopandas-readable vector file (e.g. shapefile, geopackage, etc.).

  • target_rxd (DataArray) – (rio)xarray dataset that BedMachine will be resampled to match

Returns:

bedrock mask for the target_rxd region as a (rio)xarray DataArray

Return type:

DataArray

pdemtools.data.geoid_from_bedmachine(bm_fpath: str, target_rxd: DataArray) → DataArray#

Extracts the BedMachine geoid (EIGEN-6C4), bilinearly resampled to match the target dataset.

Parameters:

  • bm_fpath (str) – Filepath to BedMachine dataset, defaults to None

  • target_rxd (DataArray) – (rio)xarray dataset that BedMachine will be resampled to match

Returns:

geoid for the target_rxd region as an xarray DataArray

Return type:

DataArray

pdemtools.data.geoid_from_raster(fpath: str, target_rxd: DataArray = None) → DataArray#

Extracts an arbritary geoid stored as a raster dataset, bilinearly resampled to match the target dataset.

Parameters:

  • fpath (str) – Filepath to geoid raster

  • target_rxd (DataArray) – (rio)xarray dataset/array that the raster will be resampled to match. Optional, defaults to None

Returns:

geoid for the target_rxd region as an xarray DataArray

Return type:

DataArray

Contents