feat: region as swisstopoclient attribute

Author: martibosch

README.md

@@ -19,11 +19,10 @@ Easily filter swisstopo STAC collections based on geospatial extents, dates, fil
 import swisstopopy
 
 region = "Lausanne, Switzerland"
-client = swisstopopy.SwissTopoClient()
+client = swisstopopy.SwissTopoClient(region)
 
 alti3d_gdf = client.gdf_from_collection(
     swisstopopy.SWISSALTI3D_COLLECTION_ID,
-    region=region,
 )
 alti3d_gdf
 ```

swisstopopy/buildings.py

@@ -117,12 +117,11 @@ def get_bldg_gdf(
     )
 
     # use the STAC API to get building heights from swissSURFACE3D and swissALTI3D
-    client = stac.SwissTopoClient()
+    client = stac.SwissTopoClient(region=region_gser)
 
     # surface3d-raster (raster dsm)
     surface3d_gdf = client.gdf_from_collection(
         stac.SWISSSURFACE3D_RASTER_COLLECTION_ID,
-        region=region_gser,
         datetime=surface3d_datetime,
     )
     # filter to get tiff images only
@@ -134,7 +133,6 @@ def get_bldg_gdf(
     # alti3d (raster dem)
     alti3d_gdf = client.gdf_from_collection(
         stac.SWISSALTI3D_COLLECTION_ID,
-        region=region_gser,
         datetime=alti3d_datetime,
     )
     # filter to get tiff images only

swisstopopy/dem.py

@@ -48,12 +48,9 @@ def get_dem_raster(
         `gdal.Warp`.
     """
     # use the STAC API to get the DEM from swissALTI3D
-    # TODO: dry with `tree_canopy.get_tree_canopy_raster`?
-    # note that we need to reproject the data to the STAC client CRS
-    client = stac.SwissTopoClient()
+    client = stac.SwissTopoClient(region=region, region_crs=region_crs)
     alti3d_gdf = client.gdf_from_collection(
         stac.SWISSALTI3D_COLLECTION_ID,
-        region=region,
         datetime=alti3d_datetime,
     )
 

swisstopopy/stac.py

@@ -122,9 +122,26 @@ def get_latest(
 
 
 class SwissTopoClient:
-    """swisstopo client."""
+    """swisstopo client.
 
-    def __init__(self):
+    Parameters
+    ----------
+    region : region-like, optional
+        Region to get the data for. Can any argument accepted by the pyregeon library.
+        If None, all the collection data will be returned.
+    region_crs : crs-like, optional
+        Coordinate reference system (CRS) of the region. Required if `region` is a naive
+        geometry or a list of bounding box coordinates. Ignored if `region` already has
+        a CRS.
+
+    """
+
+    def __init__(
+        self,
+        *,
+        region: RegionType | None = None,
+        region_crs: CRSType = None,
+    ):
         """Initialize a swisstopo client."""
         with warnings.catch_warnings():
             warnings.simplefilter("ignore")
@@ -133,12 +150,23 @@ def __init__(self):
         client.add_conforms_to("COLLECTIONS")
         self._client = client
 
+        if region is not None:
+            # rather than inheriting from `RegionMixin`, we just use the
+            # `_process_region_arg` static method
+            self.region = (
+                RegionMixin._process_region_arg(region, region_crs=region_crs)
+                .to_crs(CLIENT_CRS)
+                .iloc[0]
+            )
+        else:
+            # set it to so that it passes the default `None` value to the `intersects`
+            # keyword argument in `pystac_client.client.Search`.
+            self.region = None
+
     def gdf_from_collection(
         self,
         collection_id: str,
         *,
-        region: RegionType | None = None,
-        region_crs: CRSType = None,
         datetime: DatetimeLike | None = None,
         collection_extents_crs: CRSType | None = None,
     ) -> gpd.GeoDataFrame:
@@ -147,16 +175,8 @@ def gdf_from_collection(
             collection_extents_crs = self._client.get_collection(
                 collection_id
             ).extra_fields["crs"][0]
-        if region is not None:
-            # TODO: make the client bound to a region (i.e., inherit from `RegionMixin`)
-            # so that we only need to do this once?
-            region = (
-                RegionMixin._process_region_arg(region, region_crs=region_crs)
-                .to_crs(CLIENT_CRS)
-                .iloc[0]
-            )
         search = self._client.search(
-            collections=[collection_id], intersects=region, datetime=datetime
+            collections=[collection_id], intersects=self.region, datetime=datetime
         )
         return gpd.GeoDataFrame(
             _postprocess_items_gdf(_items_to_gdf(search.items_as_dicts()))

swisstopopy/tree_canopy.py

@@ -105,11 +105,9 @@ def get_tree_canopy_raster(
     # note that we need to pass the STAC client's CRS to both `_process_region_arg` and
     # `to_crs`, because `region` may have another CRS and we need the extend in the
     # client's CRS
-    client = stac.SwissTopoClient()
+    client = stac.SwissTopoClient(region=region, region_crs=region_crs)
     surface3d_gdf = client.gdf_from_collection(
         stac.SWISSSURFACE3D_COLLECTION_ID,
-        region=region,
-        region_crs=region_crs,
         datetime=surface3d_datetime,
     )
     # filter to get zip assets (LiDAR) only