pdemtools 1.1.2__py3-none-any.whl → 1.2.1__py3-none-any.whl

pdemtools/__init__.py

@@ -13,6 +13,6 @@ from . import _coreg
 from . import _geomorphometry
 from . import _utils
 
-__version__ = "1.1.2"
+__version__ = "1.2.1"
 
 __all__ = ["search", "DemAccessor"]

pdemtools/data.py

@@ -3,7 +3,7 @@ processing (geoids, masks, etc), resampled to match the DEM xarray object.
 """
 
 import datetime
-from typing import Optional, Literal
+from typing import Optional, Union
 from warnings import warn
 
 import rioxarray as rxr
@@ -24,7 +24,9 @@ from ._utils import clip, get_resolution
 # from shapely.geometry.polygon import Polygon
 
 
-def geoid_from_bedmachine(bm_fpath: str, target_rxd: DataArray) -> DataArray:
+def geoid_from_bedmachine(
+    bm_fpath: str, target_rxd: DataArray, geoid_crs: Optional[Union[str, int]] = None
+) -> DataArray:
     """Extracts the BedMachine geoid (EIGEN-6C4), bilinearly resampled to match the
     target dataset.
 
@@ -32,12 +34,23 @@ def geoid_from_bedmachine(bm_fpath: str, target_rxd: DataArray) -> DataArray:
     :type bm_fpath: str
     :param target_rxd: (rio)xarray dataset that BedMachine will be resampled to match
     :type target_rxd: DataArray
+    :param geoid_crs: CRS of the geoid raster, if not stored in the geoid file metadata.
+        Optional, defaults to None
+    :type geoid_crs: Optional[Union[str, int]]
 
     :returns: geoid for the target_rxd region as an xarray DataArray
     :rtype: DataArray"""
 
     geoid = rxr.open_rasterio(f"{bm_fpath}")["geoid"]
-    geoid_crs = geoid.rio.crs
+
+    if geoid_crs is None:
+        geoid_crs = geoid.rio.crs
+        if geoid_crs is None:
+            raise ValueError(
+                "Geoid CRS could not be determined from file metadata. "
+                "Please provide `geoid_crs` parameter (e.g. 3413 or 'EPSG:3413')."
+            )
+
     geoid = geoid.squeeze().astype("float32").rio.write_crs(geoid_crs)
     geoid = geoid.rio.reproject_match(
         match_data_array=target_rxd, resampling=Resampling.bilinear
@@ -46,7 +59,11 @@ def geoid_from_bedmachine(bm_fpath: str, target_rxd: DataArray) -> DataArray:
     return geoid.squeeze()
 
 
-def geoid_from_raster(fpath: str, target_rxd: DataArray = None) -> DataArray:
+def geoid_from_raster(
+    fpath: str,
+    target_rxd: DataArray = None,
+    geoid_crs: Optional[Union[str, int]] = None,
+) -> DataArray:
     """Extracts an arbritary geoid stored as a raster dataset, bilinearly resampled to
     match the target dataset.
 
@@ -55,13 +72,24 @@ def geoid_from_raster(fpath: str, target_rxd: DataArray = None) -> DataArray:
     :param target_rxd: (rio)xarray dataset/array that the raster will be resampled to
         match. Optional, defaults to None
     :type target_rxd: DataArray
+    :param geoid_crs: CRS of the geoid raster, if not stored in the geoid file metadata.
+        Optional, defaults to None
+    :type geoid_crs: Optional[Union[str, int]]
 
     :returns: geoid for the target_rxd region as an xarray DataArray
     :rtype: DataArray
     """
 
     geoid = rxr.open_rasterio(f"{fpath}")
-    geoid_crs = geoid.rio.crs
+
+    if geoid_crs is None:
+        geoid_crs = geoid.rio.crs
+        if geoid_crs is None:
+            raise ValueError(
+                "Geoid CRS could not be determined from file metadata. "
+                "Please provide `geoid_crs` parameter (e.g. 3413 or 'EPSG:3413')."
+            )
+
     geoid = geoid.squeeze().astype("float32").rio.write_crs(geoid_crs)
 
     if target_rxd != None:
@@ -73,7 +101,9 @@ def geoid_from_raster(fpath: str, target_rxd: DataArray = None) -> DataArray:
 
 
 def bedrock_mask_from_vector(
-    vector: str | GeoDataFrame, target_rxd: DataArray
+    vector: str | GeoDataFrame,
+    target_rxd: DataArray,
+    mask_crs: Optional[Union[str, int]] = None,
 ) -> 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
@@ -84,6 +114,9 @@ def bedrock_mask_from_vector(
     :type vector_fpath: str | GeoDataFrame
     :param target_rxd: (rio)xarray dataset that BedMachine will be resampled to match
     :type target_rxd: DataArray
+    :param mask_crs: CRS of the vector file, if not stored in the file metadata.
+        Optional, defaults to None
+    :type mask_crs: Optional[Union[str, int]]
 
     :returns: bedrock mask for the target_rxd region as a (rio)xarray DataArray
     :rtype: DataArray
@@ -97,12 +130,26 @@ def bedrock_mask_from_vector(
         raise ValueError(
             "Input `vector` must be either a filepath string or GeoPandas GeoDataFrame"
         )
+
+    if mask_crs is None:
+        mask_crs = gdf_clip.crs
+        if mask_crs is None:
+            raise ValueError(
+                "Vector CRS could not be determined from file metadata. "
+                "Please provide `mask_crs` parameter (e.g. 3413 or 'EPSG:3413')."
+            )
+
+    if gdf_clip.crs != target_rxd.rio.crs:
+        gdf_clip = gdf_clip.to_crs(target_rxd.rio.crs)
+
     target_rxd = target_rxd.rio.write_nodata(-9999)  # Enforce -9999 as nodata value
     target_clip = target_rxd.rio.clip(gdf_clip.geometry.values, drop=False)
     return (target_clip.where(target_clip != -9999) * 0 + 1).fillna(0).squeeze()
 
 
-def bedrock_mask_from_bedmachine(bm_fpath: str, target_rxd: DataArray) -> DataArray:
+def bedrock_mask_from_bedmachine(
+    bm_fpath: str, target_rxd: DataArray, mask_crs: Optional[Union[str, int]] = None
+) -> DataArray:
     """Construct boolean bedrock mask from bedmachine and a given target rioxarray
     dataset. Returns mask where bedrock values are 1 and outside are 0.
 
@@ -110,6 +157,9 @@ def bedrock_mask_from_bedmachine(bm_fpath: str, target_rxd: DataArray) -> DataAr
     :type bm_fpath: str
     :param target_rxd: (rio)xarray dataset that BedMachine will be resampled to match
     :type target_rxd: DataArray
+    :param mask_crs: CRS of the BedMachine dataset, if not stored in the file metadata.
+        Optional, defaults to None
+    :type mask_crs: Optional[Union[str, int]]
 
     :returns: bedrock mask for the target_rxd region as a (rio)xarray DataArray
     :rtype: DataArray
@@ -117,7 +167,13 @@ def bedrock_mask_from_bedmachine(bm_fpath: str, target_rxd: DataArray) -> DataAr
 
     # Open geoid
     mask = rxr.open_rasterio(f"{bm_fpath}")["mask"]
-    mask_crs = mask.rio.crs
+    if mask_crs is None:
+        mask_crs = mask.rio.crs
+        if mask_crs is None:
+            raise ValueError(
+                "BedMachine CRS could not be determined from file metadata. "
+                "Please provide `mask_crs` parameter (e.g. 3413 or 'EPSG:3413')."
+            )
 
     # Get geoid-projected geometry of the extent of the target dataset,
     # with a bit of a buffer for safety

{pdemtools-1.1.2.dist-info → pdemtools-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pdemtools
-Version: 1.1.2
+Version: 1.2.1
 Summary: Conveniently search, download, and preprocess ArcticDEM and REMA products.
 Author-email: Tom Chudley <thomas.r.chudley@durham.ac.uk>
 License: MIT

{pdemtools-1.1.2.dist-info → pdemtools-1.2.1.dist-info}/RECORD

@@ -1,17 +1,17 @@
-pdemtools/__init__.py,sha256=raXB8EvZxUAwDKT3XmaXuD1UDm0d11Rv1Hkyh15kLD4,368
+pdemtools/__init__.py,sha256=aOo61W2rtFpdiNWBIc5UWF3GmVMhZkDtvIWPSuLbIqU,368
 pdemtools/_accessor.py,sha256=RNxts9ruziueo3-sZBruU2DmDmaZumBA7Kac9w_Zn3Y,36387
 pdemtools/_coreg.py,sha256=n6idsTsCeATzxrD4foeLJ4-QqUM-4HkfCX8OKIUDY3c,16577
 pdemtools/_geomorphometry.py,sha256=NyGb-z2_ZrEuiwi37zjI7z-J0Zr-Wnt2KMkiVP1NxAw,8739
 pdemtools/_index_search.py,sha256=KLbU1GIezrumL4nMaLe0C074uKThbnprdDnPw2yYLfk,20180
 pdemtools/_utils.py,sha256=Bym7p9yKOy3lHpGGaMEdYxD8dvpZ8CO_MCWXCuc4CRk,2280
-pdemtools/data.py,sha256=6peONDu-qAQtz5KAFd2m3AaLeM8FNMWVQfuYcDNydAU,13965
+pdemtools/data.py,sha256=2yIEEC0lIb9MIvyrVIP2yWo64la4sa85uyuXu10SPdU,16023
 pdemtools/load.py,sha256=wrIQ2JOxR-nhms1dDPb6JBh2i5irwsvO4jhTngofwGw,18483
 pdemtools/mosaic_index/ArcticDEM_Mosaic_Index_v3_gpkg.gpkg,sha256=15f2IEo0mnz8LAamm_UG_x_2e0q7k8HnVd_dUSg_O3Y,8540160
 pdemtools/mosaic_index/ArcticDEM_Mosaic_Index_v4_1_gpkg.gpkg,sha256=vDrBdlLtmy0dcKYvaORCOWTkWzYtwK5B3JnQiCThL8s,8552448
 pdemtools/mosaic_index/REMA_Mosaic_Index_v2_gpkg.gpkg,sha256=HrRKp5lWpbCOmpHwANHSVc_eO0qo11J42CGuQEmmUQc,5177344
 pdemtools/test_data/test_arcticdem_index_kiv_steenstrup.parquet,sha256=Nzg3HXPbef4VgrnZXiAAa8RxmhBcFoqMNiFpm3_u99Y,91756
-pdemtools-1.1.2.dist-info/licenses/LICENSE.md,sha256=JbOkncS9jKLCvDWUpTApk8QhBLtfy-pRs74Gw6mVVPk,1068
-pdemtools-1.1.2.dist-info/METADATA,sha256=8vKoQ9uwZVocWRC1MscYWxpWXE27Vc72Z8W_sZJ7EV8,7214
-pdemtools-1.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pdemtools-1.1.2.dist-info/top_level.txt,sha256=nTm0PsXQSEKsrI9f5XKoiQor9c_pLGgxuuWt5l425GM,10
-pdemtools-1.1.2.dist-info/RECORD,,
+pdemtools-1.2.1.dist-info/licenses/LICENSE.md,sha256=JbOkncS9jKLCvDWUpTApk8QhBLtfy-pRs74Gw6mVVPk,1068
+pdemtools-1.2.1.dist-info/METADATA,sha256=5MwKCDVuR09m0l2z5paR-1OEOo1Grk9rCW9nqDEkXzQ,7214
+pdemtools-1.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pdemtools-1.2.1.dist-info/top_level.txt,sha256=nTm0PsXQSEKsrI9f5XKoiQor9c_pLGgxuuWt5l425GM,10
+pdemtools-1.2.1.dist-info/RECORD,,