ssb-sgis 1.0.2__tar.gz → 1.0.3__tar.gz

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ssb-sgis
-Version: 1.0.2
+Version: 1.0.3
 Summary: GIS functions used at Statistics Norway.
 Home-page: https://github.com/statisticsnorway/ssb-sgis
 License: MIT

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-sgis"
-version = "1.0.2"
+version = "1.0.3"
 description = "GIS functions used at Statistics Norway."
 authors = ["Morten Letnes <morten.letnes@ssb.no>"]
 license = "MIT"

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/__init__.py

@@ -115,12 +115,16 @@ from .networkanalysis.traveling_salesman import traveling_salesman_problem
 from .parallel.parallel import Parallel
 from .parallel.parallel import parallel_overlay
 from .raster.cube import DataCube
-
-try:
-    import sgis.raster.torchgeo as torchgeo
-except ImportError:
-    pass
-
+from .raster.cube import concat_cubes
+from .raster.image_collection import Band
+from .raster.image_collection import Image
+from .raster.image_collection import ImageCollection
+from .raster.image_collection import Sentinel2Band
+from .raster.image_collection import Sentinel2CloudlessCollection
+from .raster.image_collection import Sentinel2CloudlessImage
+from .raster.image_collection import Sentinel2Collection
+from .raster.image_collection import Sentinel2Image
+from .raster.image_collection import concat_image_collections
 
 try:
     from .io.dapla_functions import check_files

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/exceptions.py

@@ -1,7 +1,7 @@
 """Some small exception classes."""
 
 
-class NoPointsWithinSearchToleranceError(Exception):
+class NoPointsWithinSearchToleranceError(ValueError):
     """Exception for when the points are too far away from the network."""
 
     def __init__(
@@ -19,5 +19,5 @@ class NoPointsWithinSearchToleranceError(Exception):
         )
 
 
-class ZeroLinesError(Exception):
+class ZeroLinesError(ValueError):
     """DataFrame has 0 rows."""

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/geopandas_tools/bounds.py

@@ -37,7 +37,7 @@ class Gridlooper:
             Defaults to True.
 
     Examples:
-    --------
+    ---------
     Get some points and some polygons.
 
     >>> import sgis as sg
@@ -222,7 +222,7 @@ def gridloop(
         TypeError: If args or kwargs has a wrong type
 
     Examples:
-    --------
+    ---------
     Get some points and some polygons.
 
     >>> import sgis as sg
@@ -442,7 +442,7 @@ def make_grid(
     obj: GeoDataFrame | GeoSeries | Geometry | tuple,
     gridsize: int | float,
     *,
-    crs: CRS = None,
+    crs: CRS | None = None,
     clip_to_bounds: bool = False,
 ) -> GeoDataFrame:
     """Create a polygon grid around geometries.
@@ -467,10 +467,6 @@ def make_grid(
     """
     if isinstance(obj, (GeoDataFrame | GeoSeries)):
         crs = obj.crs or crs
-    elif not crs:
-        raise ValueError(
-            "'crs' cannot be None when 'obj' is not GeoDataFrame/GeoSeries."
-        )
     if hasattr(obj, "__len__") and not len(obj):
         return GeoDataFrame({"geometry": []}, crs=crs)
 
@@ -617,7 +613,7 @@ def bounds_to_polygon(
         GeoDataFrame of box polygons with length and index of 'gdf'.
 
     Examples:
-    --------
+    ---------
     >>> import sgis as sg
     >>> gdf = sg.to_gdf([MultiPoint([(0, 0), (1, 1)]), Point(0, 0)])
     >>> gdf
@@ -652,7 +648,7 @@ def bounds_to_points(
         GeoDataFrame of multipoints with same length and index as 'gdf'.
 
     Examples:
-    --------
+    ---------
     >>> import sgis as sg
     >>> gdf = sg.to_gdf([MultiPoint([(0, 0), (1, 1)]), Point(0, 0)])
     >>> gdf
@@ -680,13 +676,19 @@ def get_total_bounds(
     for obj in geometries:
         try:
             minx, miny, maxx, maxy = to_bbox(obj)
+            xs += [minx, maxx]
+            ys += [miny, maxy]
         except Exception as e:
-            if strict:
-                raise e
-            else:
-                continue
-        xs += [minx, maxx]
-        ys += [miny, maxy]
+            try:
+                for x in obj:
+                    minx, miny, maxx, maxy = to_bbox(x)
+                    xs += [minx, maxx]
+                    ys += [miny, maxy]
+            except Exception as e2:
+                if strict:
+                    raise e2 from e
+                else:
+                    continue
     return min(xs), min(ys), max(xs), max(ys)
 
 

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/geopandas_tools/buffer_dissolve_explode.py

@@ -52,6 +52,7 @@ def buffdissexp(
     copy: bool = True,
     grid_size: float | int | None = None,
     n_jobs: int = 1,
+    join_style: int | str = "round",
     **dissolve_kwargs,
 ) -> GeoDataFrame:
     """Buffers and dissolves overlapping geometries.
@@ -71,6 +72,7 @@ def buffdissexp(
         copy: Whether to copy the GeoDataFrame before buffering. Defaults to True.
         grid_size: Rounding of the coordinates. Defaults to None.
         n_jobs: Number of threads to use. Defaults to 1.
+        join_style: Buffer join style.
         **dissolve_kwargs: additional keyword arguments passed to geopandas' dissolve.
 
     Returns:
@@ -85,6 +87,7 @@ def buffdissexp(
         copy=copy,
         grid_size=grid_size,
         n_jobs=n_jobs,
+        join_style=join_style,
         **dissolve_kwargs,
     )
 
@@ -99,6 +102,7 @@ def buffdiss(
     resolution: int = 50,
     copy: bool = True,
     n_jobs: int = 1,
+    join_style: int | str = "round",
     **dissolve_kwargs,
 ) -> GeoDataFrame:
     """Buffers and dissolves geometries.
@@ -114,6 +118,7 @@ def buffdiss(
             the geometry by
         resolution: The number of segments used to approximate a quarter circle.
             Here defaults to 50, as opposed to the default 16 in geopandas.
+        join_style: Buffer join style.
         copy: Whether to copy the GeoDataFrame before buffering. Defaults to True.
         n_jobs: Number of threads to use. Defaults to 1.
         **dissolve_kwargs: additional keyword arguments passed to geopandas' dissolve.
@@ -122,7 +127,7 @@ def buffdiss(
         A buffered GeoDataFrame where geometries are dissolved.
 
     Examples:
-    --------
+    ---------
     Create some random points.
 
     >>> import sgis as sg
@@ -169,7 +174,9 @@ def buffdiss(
     1     b  MULTIPOLYGON (((258404.858 6647830.931, 258404...  0.687635
     2     d  MULTIPOLYGON (((258180.258 6647935.731, 258179...  0.580157
     """
-    buffered = buff(gdf, distance, resolution=resolution, copy=copy)
+    buffered = buff(
+        gdf, distance, resolution=resolution, copy=copy, join_style=join_style
+    )
 
     return _dissolve(buffered, n_jobs=n_jobs, **dissolve_kwargs)
 
@@ -462,6 +469,7 @@ def buffdissexp_by_cluster(
     resolution: int = 50,
     copy: bool = True,
     n_jobs: int = 1,
+    join_style: int | str = "round",
     **dissolve_kwargs,
 ) -> GeoDataFrame:
     """Buffers and dissolves overlapping geometries.
@@ -480,6 +488,7 @@ def buffdissexp_by_cluster(
             the geometry by
         resolution: The number of segments used to approximate a quarter circle.
             Here defaults to 50, as opposed to the default 16 in geopandas.
+        join_style: Buffer join style.
         copy: Whether to copy the GeoDataFrame before buffering. Defaults to True.
         n_jobs: int = 1,
         **dissolve_kwargs: additional keyword arguments passed to geopandas' dissolve.
@@ -487,7 +496,13 @@ def buffdissexp_by_cluster(
     Returns:
         A buffered GeoDataFrame where overlapping geometries are dissolved.
     """
-    buffered = buff(gdf, distance, resolution=resolution, copy=copy)
+    buffered = buff(
+        gdf,
+        distance,
+        resolution=resolution,
+        copy=copy,
+        join_style=join_style,
+    )
     return dissexp_by_cluster(buffered, n_jobs=n_jobs, **dissolve_kwargs)
 
 
@@ -496,6 +511,7 @@ def buff(
     distance: int | float,
     resolution: int = 50,
     copy: bool = True,
+    join_style: int | str = "round",
     **buffer_kwargs,
 ) -> GeoDataFrame:
     """Buffers a GeoDataFrame with high resolution and returns a new GeoDataFrame.
@@ -506,6 +522,7 @@ def buff(
             the geometry by
         resolution: The number of segments used to approximate a quarter circle.
             Here defaults to 50, as opposed to the default 16 in geopandas.
+        join_style: Buffer join style.
         copy: Whether to copy the GeoDataFrame before buffering. Defaults to True.
         **buffer_kwargs: additional keyword arguments passed to geopandas' buffer.
 
@@ -513,13 +530,15 @@ def buff(
         A buffered GeoDataFrame.
     """
     if isinstance(gdf, GeoSeries):
-        return gdf.buffer(distance, resolution=resolution, **buffer_kwargs).make_valid()
+        return gdf.buffer(
+            distance, resolution=resolution, join_style=join_style, **buffer_kwargs
+        ).make_valid()
 
     if copy:
         gdf = gdf.copy()
 
     gdf[gdf._geometry_column_name] = gdf.buffer(
-        distance, resolution=resolution, **buffer_kwargs
+        distance, resolution=resolution, join_style=join_style, **buffer_kwargs
     ).make_valid()
 
     return gdf

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/geopandas_tools/conversion.py

@@ -90,8 +90,10 @@ def to_shapely(obj: Any) -> Geometry:
         return obj
     if not hasattr(obj, "__iter__"):
         raise TypeError(type(obj))
-    if hasattr(obj, "unary_union"):
+    try:
         return obj.unary_union
+    except AttributeError:
+        pass
     try:
         return Point(*obj)
     except TypeError:
@@ -108,6 +110,7 @@ def to_shapely(obj: Any) -> Geometry:
         return shapely.wkb.loads(obj)
     except TypeError:
         pass
+    raise TypeError(type(obj))
 
 
 def to_bbox(
@@ -122,9 +125,15 @@ def to_bbox(
             "xmin", "ymin", "xmax", "ymax".
     """
     if isinstance(obj, (GeoDataFrame, GeoSeries)):
-        return tuple(obj.total_bounds)
-    if isinstance(obj, Geometry):
-        return tuple(obj.bounds)
+        bounds = tuple(obj.total_bounds)
+        assert isinstance(bounds, tuple)
+        return bounds
+    try:
+        bounds = tuple(obj.bounds)
+        assert isinstance(bounds, tuple)
+        return bounds
+    except Exception:
+        pass
 
     try:
         minx = int(np.min(obj["minx"]))  # type: ignore [index]
@@ -195,7 +204,7 @@ def coordinate_array(
         np.ndarray of np.ndarrays of coordinates.
 
     Examples:
-    --------
+    ---------
     >>> import sgis as sg
     >>> points = sg.to_gdf(
     ...     [
@@ -279,7 +288,7 @@ def to_gdf(
         A GeoDataFrame with one column, the geometry column.
 
     Examples:
-    --------
+    ---------
     >>> import sgis as sg
     >>> coords = (10, 60)
     >>> sg.to_gdf(coords, crs=4326)

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/geopandas_tools/duplicates.py

@@ -54,7 +54,7 @@ def update_geometries(
         predicate: Spatial predicate for the spatial tree.
 
     Example:
-    ------
+    --------
     Create two circles and get the overlap.
 
     >>> import sgis as sg
@@ -213,7 +213,7 @@ def get_intersections(
         A GeoDataFrame of the overlapping polygons.
 
     Examples:
-    --------
+    ---------
     Create three partially overlapping polygons.
 
     >>> import sgis as sg

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/geopandas_tools/general.py

@@ -4,7 +4,6 @@ from collections.abc import Hashable
 from collections.abc import Iterable
 from typing import Any
 
-import dask_geopandas
 import joblib
 import numpy as np
 import pandas as pd
@@ -27,6 +26,11 @@ from shapely import unary_union
 from shapely.geometry import LineString
 from shapely.geometry import Point
 
+try:
+    import dask_geopandas
+except ImportError:
+    pass
+
 from .geometry_types import get_geom_type
 from .geometry_types import make_all_singlepart
 from .geometry_types import to_single_geom_type
@@ -164,7 +168,7 @@ def clean_geoms(
         non-empty and not-NaN/-None geometries.
 
     Examples:
-    --------
+    ---------
     >>> import sgis as sg
     >>> import pandas as pd
     >>> from shapely import wkt
@@ -281,7 +285,7 @@ def sort_large_first(gdf: GeoDataFrame | GeoSeries) -> GeoDataFrame | GeoSeries:
         A GeoDataFrame or GeoSeries sorted from large to small in area.
 
     Examples:
-    --------
+    ---------
     Create GeoDataFrame with NaN values.
 
     >>> import sgis as sg
@@ -423,7 +427,7 @@ def random_points(n: int, loc: float | int = 0.5) -> GeoDataFrame:
         A GeoDataFrame of points with n rows.
 
     Examples:
-    --------
+    ---------
     >>> import sgis as sg
     >>> points = sg.random_points(10_000)
     >>> points
@@ -523,7 +527,7 @@ def to_lines(*gdfs: GeoDataFrame, copy: bool = True) -> GeoDataFrame:
         always ignores the index.
 
     Examples:
-    --------
+    ---------
     Convert single polygon to linestring.
 
     >>> import sgis as sg

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/geopandas_tools/geometry_types.py

@@ -64,7 +64,7 @@ def to_single_geom_type(
         ValueError: If 'geom_type' is neither 'polygon', 'line' or 'point'.
 
     Examples:
-    --------
+    ---------
     First create a GeoDataFrame of mixed geometries.
 
     >>> from sgis import to_gdf, to_single_geom_type
@@ -156,7 +156,7 @@ def get_geom_type(gdf: GeoDataFrame | GeoSeries) -> str:
         TypeError: If 'gdf' is not of type GeoDataFrame or GeoSeries.
 
     Examples:
-    --------
+    ---------
     >>> from sgis import to_gdf, get_geom_type
     >>> gdf = to_gdf([0, 0])
     >>> gdf
@@ -204,7 +204,7 @@ def is_single_geom_type(gdf: GeoDataFrame | GeoSeries) -> bool:
         TypeError: If 'gdf' is not of type GeoDataFrame or GeoSeries.
 
     Examples:
-    --------
+    ---------
     >>> from sgis import to_gdf, get_geom_type
     >>> gdf = to_gdf([0, 0])
     >>> gdf

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/geopandas_tools/neighbors.py

@@ -50,7 +50,7 @@ def get_neighbor_indices(
             system.
 
     Examples:
-    --------
+    ---------
     >>> from sgis import get_neighbor_indices, to_gdf
     >>> points = to_gdf([(0, 0), (0.5, 0.5)])
     >>> points
@@ -153,7 +153,7 @@ def get_all_distances(
             not the same.
 
     Examples:
-    --------
+    ---------
     >>> from sgis import get_all_distances, random_points
     >>> points = random_points(100)
     >>> neighbors = random_points(100)
@@ -297,7 +297,7 @@ def get_k_nearest_neighbors(
             not the same.
 
     Examples:
-    --------
+    ---------
     Make some random points.
 
     >>> from sgis import get_k_nearest_neighbors, random_points

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/geopandas_tools/point_operations.py

@@ -48,7 +48,7 @@ def snap_within_distance(
         vertices.
 
     Examples:
-    --------
+    ---------
     Create som points.
 
     >>> from sgis import snap_within_distance, to_gdf
@@ -136,7 +136,7 @@ def snap_all(
         vertices.
 
     Examples:
-    --------
+    ---------
     Create som points.
 
     >>> from sgis import snap_all, to_gdf

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/geopandas_tools/polygon_operations.py

@@ -70,7 +70,7 @@ def get_polygon_clusters(
         One or more GeoDataFrames (same amount as was given) with a new cluster column.
 
     Examples:
-    --------
+    ---------
     Create geometries with three clusters of overlapping polygons.
 
     >>> import sgis as sg
@@ -250,7 +250,7 @@ def eliminate_by_longest(
         If multiple GeoDataFrame are passed as 'gdf', they are returned as a tuple.
 
     Examples:
-    --------
+    ---------
     Create two polygons with a sliver in between:
 
     >>> sliver = sg.to_gdf(Polygon([(0, 0), (0.1, 1), (0, 2), (-0.1, 1)]))
@@ -426,7 +426,7 @@ def eliminate_by_largest(
         If multiple GeoDataFrame are passed as 'gdf', they are returned as a tuple.
 
     Examples:
-    --------
+    ---------
     Create two polygons with a sliver in between:
 
     >>> sliver = sg.to_gdf(Polygon([(0, 0), (0.1, 1), (0, 2), (-0.1, 1)]))
@@ -803,7 +803,7 @@ def close_all_holes(
         column.
 
     Examples:
-    --------
+    ---------
     Let's create a circle with a hole in it.
 
     >>> point = sg.to_gdf([260000, 6650000], crs=25833)
@@ -892,7 +892,7 @@ def close_small_holes(
         ValueError: If both 'max_m2' and 'max_km2' is given.
 
     Examples:
-    --------
+    ---------
     Let's create a circle with a hole in it.
 
     >>> point = sg.to_gdf([260000, 6650000], crs=25833)

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/geopandas_tools/sfilter.py

@@ -35,7 +35,7 @@ def sfilter(
         spatial predicate with 'other'.
 
     Examples:
-    --------
+    ---------
     >>> import sgis as sg
     >>> df1 = sg.to_gdf([(0, 0), (0, 1)])
     >>> df1
@@ -101,7 +101,7 @@ def sfilter_split(
         and one with the rows that do not.
 
     Examples:
-    --------
+    ---------
     >>> import sgis as sg
     >>> df1 = sg.to_gdf([(0, 0), (0, 1)])
     >>> df1
@@ -172,7 +172,7 @@ def sfilter_inverse(
         spatial predicate with 'other'.
 
     Examples:
-    --------
+    ---------
     >>> import sgis as sg
     >>> df1 = sg.to_gdf([(0, 0), (0, 1)])
     >>> df1

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/helpers.py

@@ -141,7 +141,7 @@ def get_all_files(root: str, recursive: bool = True) -> list[str]:
         A list of file paths.
     """
     if not recursive:
-        return [path for path in glob.glob(str(Path(root)) + "/*")]
+        return [path for path in glob.glob(str(Path(root)) + "/**")]
     paths = []
     for root_dir, _, files in os.walk(root):
         for file in files:
@@ -205,7 +205,7 @@ def unit_is_degrees(gdf: GeoDataFrame) -> bool:
 
 def get_object_name(
     var: object, start: int = 2, stop: int = 7, ignore_self: bool = True
-) -> str | None:
+) -> str:
     frame = inspect.currentframe()  # frame can be FrameType or None
     if frame:
         try:
@@ -230,7 +230,7 @@ def get_object_name(
         finally:
             if frame:
                 del frame  # Explicitly delete frame reference to assist with garbage collection
-    return None
+    raise ValueError(f"Couldn't find name for {var}")
 
 
 def make_namedict(gdfs: tuple[GeoDataFrame]) -> dict[int, str]:

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/io/read_parquet.py

@@ -15,7 +15,7 @@ def read_parquet_url(url: str) -> GeoDataFrame:
         A GeoDataFrame.
 
     Examples:
-    --------
+    ---------
     >>> from sgis import read_parquet_url
     >>> url = "https://media.githubusercontent.com/media/statisticsnorway/ssb-sgis/main/tests/testdata/points_oslo.parquet"
     >>> points = read_parquet_url(url)

{ssb_sgis-1.0.2 → ssb_sgis-1.0.3}/src/sgis/maps/examine.py

@@ -3,6 +3,10 @@ import numpy as np
 
 from ..geopandas_tools.bounds import get_total_bounds
 from ..helpers import unit_is_degrees
+from ..raster.image_collection import Band
+from ..raster.image_collection import Image
+from ..raster.image_collection import ImageCollection
+from .explore import Explore
 from .map import Map
 from .maps import clipmap
 from .maps import explore
@@ -22,7 +26,7 @@ class Examine:
     can then be repeated.
 
     Examples:
-    --------
+    ---------
     Create the examiner.
 
     >>> import sgis as sg
@@ -93,11 +97,15 @@ class Examine:
         else:
             self.mask_gdf = mask_gdf
 
-        m = Map(*gdfs, column=column, **kwargs)
+        m = Explore(*gdfs, column=column, **kwargs)
+
+        # m = Map(*gdfs, column=column, **kwargs)
         self._gdfs: dict[str, gpd.GeoDataFrame] = dict(
             zip(m.labels, m.gdfs, strict=False)
         )
 
+        self.rasters: dict[str, ImageCollection | Image | Band] = m.rasters
+
         self.indices = list(range(len(self.mask_gdf)))
         self.i = 0
         self.column = column
@@ -154,6 +162,7 @@ class Examine:
         print(f"i == {self.i} (of {len(self.mask_gdf)})")
         clipmap(
             self.column,
+            *list(self.rasters.values()),
             **self._gdfs,
             mask=self.mask_gdf.iloc[[self.i]].buffer(self.size),
             **self.kwargs,
@@ -175,6 +184,7 @@ class Examine:
         print(f"Showing index {i}")
         clipmap(
             self.column,
+            *list(self.rasters.values()),
             **self._gdfs,
             mask=self.mask_gdf.iloc[[i]].buffer(self.size),
             **self.kwargs,
@@ -194,6 +204,7 @@ class Examine:
         print(f"{self.i + 1} of {len(self.mask_gdf)}")
         clipmap(
             self.column,
+            *list(self.rasters.values()),
             **self._gdfs,
             mask=self.mask_gdf.iloc[[self.i]].buffer(self.size),
             **self.kwargs,
@@ -206,6 +217,7 @@ class Examine:
             self.kwargs = self.kwargs | kwargs
 
         explore(
+            *list(self.rasters.values()),
             **self._gdfs,
             column=self.column,
             **self.kwargs,
@@ -218,6 +230,7 @@ class Examine:
             self.kwargs = self.kwargs | kwargs
 
         clipmap(
+            *list(self.rasters.values()),
             **self._gdfs,
             column=self.column,
             **self.kwargs,
@@ -230,6 +243,7 @@ class Examine:
             self.kwargs = self.kwargs | kwargs
 
         samplemap(
+            *list(self.rasters.values()),
             **self._gdfs,
             column=self.column,
             **self.kwargs,