ssb-sgis 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

sgis/maps/maps.py

@@ -8,37 +8,45 @@ The 'qtm' function shows a simple static map of one or more GeoDataFrames.
 """
 
 import inspect
+import random
 from numbers import Number
 from typing import Any
 
-from geopandas import GeoDataFrame, GeoSeries
-from pyproj import CRS
+import pyproj
+from geopandas import GeoDataFrame
+from geopandas import GeoSeries
 from shapely import Geometry
-
-from ..geopandas_tools.conversion import to_gdf as to_gdf_func
-from ..geopandas_tools.general import clean_geoms, get_common_crs, is_wkt
+from shapely import box
+from shapely.geometry import Polygon
+
+from ..geopandas_tools.bounds import get_total_bounds
+from ..geopandas_tools.conversion import to_bbox
+from ..geopandas_tools.conversion import to_gdf
+from ..geopandas_tools.conversion import to_shapely
+from ..geopandas_tools.general import clean_geoms
+from ..geopandas_tools.general import get_common_crs
+from ..geopandas_tools.general import is_wkt
 from ..geopandas_tools.geocoding import address_to_gdf
 from ..geopandas_tools.geometry_types import get_geom_type
 from .explore import Explore
 from .map import Map
 from .thematicmap import ThematicMap
 
-
 try:
     from torchgeo.datasets.geo import RasterDataset
 except ImportError:
 
     class RasterDataset:
-        """Placeholder"""
+        """Placeholder."""
 
 
 def _get_location_mask(kwargs: dict, gdfs) -> tuple[GeoDataFrame | None, dict]:
     try:
         crs = get_common_crs(gdfs)
-    except IndexError:
+    except (IndexError, pyproj.exceptions.CRSError):
         for x in kwargs.values():
             try:
-                crs = CRS(x.crs) if hasattr(x, "crs") else CRS(x["crs"])
+                crs = pyproj.CRS(x.crs) if hasattr(x, "crs") else pyproj.CRS(x["crs"])
                 break
             except Exception:
                 crs = None
@@ -62,7 +70,7 @@ def _get_location_mask(kwargs: dict, gdfs) -> tuple[GeoDataFrame | None, dict]:
             kwargs.pop(key)
             if isinstance(value, Number) and value > 1:
                 size = value
-            the_mask = to_gdf_func([mask], crs=4326).to_crs(crs).buffer(size)
+            the_mask = to_gdf([mask], crs=4326).to_crs(crs).buffer(size)
             return the_mask, kwargs
 
     return None, kwargs
@@ -72,14 +80,13 @@ def explore(
     *gdfs: GeoDataFrame | dict[str, GeoDataFrame],
     column: str | None = None,
     center: Any | None = None,
-    center_4326: Any | None = None,
-    labels: tuple[str] | None = None,
     max_zoom: int = 40,
     browser: bool = False,
     smooth_factor: int | float = 1.5,
     size: int | None = None,
+    max_images: int = 15,
     **kwargs,
-) -> None:
+) -> Explore:
     """Interactive map of GeoDataFrames with layers that can be toggled on/off.
 
     It takes all the given GeoDataFrames and displays them together in an
@@ -94,13 +101,9 @@ def explore(
         *gdfs: one or more GeoDataFrames.
         column: The column to color the geometries by. Defaults to None, which means
             each GeoDataFrame will get a unique color.
-        center: Either an address string to be geocoded or a geometry like object
-            (coordinate pair (x, y), GeoDataFrame, bbox, etc.). If the geometry is a
-            point (or line), it will be buffered by 1000 (can be changed with the)
-            size parameter. If a polygon is given, it will not be buffered.
-        labels: By default, the GeoDataFrames will be labeled by their object names.
-            Alternatively, labels can be specified as a tuple of strings with the same
-            length as the number of gdfs.
+        center: Geometry-like object to center the map on. If a three-length tuple
+            is given, the first two should be x and y coordinates and the third
+            should be a number of meters to buffer the centerpoint by.
         max_zoom: The maximum allowed level of zoom. Higher number means more zoom
             allowed. Defaults to 30, which is higher than the geopandas default.
         browser: If False (default), the maps will be shown in Jupyter.
@@ -109,17 +112,19 @@ def explore(
             5 is quite a lot of simplification.
         size: The buffer distance. Only used when center is given. It then defaults to
             1000.
+        max_images: Maximum number of images (Image, ImageCollection, Band) to show per
+            map. Defaults to 15.
         **kwargs: Keyword arguments to pass to geopandas.GeoDataFrame.explore, for
             instance 'cmap' to change the colors, 'scheme' to change how the data
             is grouped. This defaults to 'fisherjenkssampled' for numeric data.
 
-    See also
-    --------
+    See Also:
+    ---------
     samplemap: same functionality, but shows only a random area of a given size.
     clipmap: same functionality, but shows only the areas clipped by a given mask.
 
-    Examples
-    --------
+    Examples:
+    ---------
     >>> import sgis as sg
     >>> roads = sg.read_parquet_url("https://media.githubusercontent.com/media/statisticsnorway/ssb-sgis/main/tests/testdata/roads_oslo_2022.parquet")
     >>> points = sg.read_parquet_url("https://media.githubusercontent.com/media/statisticsnorway/ssb-sgis/main/tests/testdata/points_oslo.parquet")
@@ -138,7 +143,6 @@ def explore(
     >>> points["meters"] = points.length
     >>> sg.explore(roads, points, column="meters", cmap="plasma", max_zoom=60, center_4326=(10.7463, 59.92, 500))
     """
-
     gdfs, column, kwargs = Map._separate_args(gdfs, column, kwargs)
 
     loc_mask, kwargs = _get_location_mask(kwargs | {"size": size}, gdfs)
@@ -152,7 +156,6 @@ def explore(
             *gdfs,
             column=column,
             mask=mask,
-            labels=labels,
             browser=browser,
             max_zoom=max_zoom,
             **kwargs,
@@ -160,16 +163,13 @@ def explore(
 
     try:
         to_crs = gdfs[0].crs
-    except IndexError:
+    except (IndexError, AttributeError):
         try:
-            to_crs = [x for x in kwargs.values() if hasattr(x, "crs")][0].crs
-        except IndexError:
+            to_crs = next(x for x in kwargs.values() if hasattr(x, "crs")).crs
+        except (IndexError, StopIteration):
             to_crs = None
 
-    if center_4326 is not None:
-        from_crs = 4326
-        center = center_4326
-    elif "crs" in kwargs:
+    if "crs" in kwargs:
         from_crs = kwargs.pop("crs")
     else:
         from_crs = to_crs
@@ -183,7 +183,11 @@ def explore(
         else:
             if isinstance(center, (tuple, list)) and len(center) == 3:
                 *center, size = center
-            mask = to_gdf_func(center, crs=from_crs)
+            mask = to_gdf(center, crs=from_crs)
+
+        bounds: Polygon = box(*get_total_bounds(*gdfs, *list(kwargs.values())))
+        if not mask.intersects(bounds).any():
+            mask = mask.set_crs(4326, allow_override=True)
 
         try:
             mask = mask.to_crs(to_crs)
@@ -197,7 +201,6 @@ def explore(
             *gdfs,
             column=column,
             mask=mask,
-            labels=labels,
             browser=browser,
             max_zoom=max_zoom,
             **kwargs,
@@ -206,34 +209,36 @@ def explore(
     m = Explore(
         *gdfs,
         column=column,
-        labels=labels,
         browser=browser,
         max_zoom=max_zoom,
         smooth_factor=smooth_factor,
+        max_images=max_images,
         **kwargs,
     )
 
-    if m.gdfs is None and not len(m.raster_datasets):
-        return
+    if m.gdfs is None and not len(m.rasters):
+        return m
 
     if not kwargs.pop("explore", True):
         return qtm(m._gdf, column=m.column, cmap=m._cmap, k=m.k)
 
     m.explore()
 
+    return m
+
 
 def samplemap(
     *gdfs: GeoDataFrame,
     column: str | None = None,
     size: int = 1000,
     sample_from_first: bool = True,
-    labels: tuple[str] | None = None,
     max_zoom: int = 40,
     smooth_factor: int = 1.5,
     explore: bool = True,
     browser: bool = False,
+    max_images: int = 15,
     **kwargs,
-) -> None:
+) -> Explore:
     """Shows an interactive map of a random area of GeoDataFrames.
 
     It takes all the GeoDataFrames specified, takes a random sample point from the
@@ -255,9 +260,6 @@ def samplemap(
             Defaults to 1000 (meters).
         sample_from_first: If True (default), the sample point is taken form the
             first specified GeoDataFrame. If False, all GeoDataFrames are considered.
-        labels: By default, the GeoDataFrames will be labeled by their object names.
-            Alternatively, labels can be specified as a tuple of strings the same
-            length as the number of gdfs.
         max_zoom: The maximum allowed level of zoom. Higher number means more zoom
             allowed. Defaults to 30, which is higher than the geopandas default.
         smooth_factor: How much to simplify the geometries. 1 is the minimum,
@@ -266,17 +268,19 @@ def samplemap(
             or not in Jupyter, a static plot will be shown.
         browser: If False (default), the maps will be shown in Jupyter.
             If True the maps will be opened in a browser folder.
+        max_images: Maximum number of images (Image, ImageCollection, Band) to show per
+            map. Defaults to 15.
         **kwargs: Keyword arguments to pass to geopandas.GeoDataFrame.explore, for
             instance 'cmap' to change the colors, 'scheme' to change how the data
             is grouped. This defaults to 'fisherjenkssampled' for numeric data.
 
-    See also
-    --------
+    See Also:
+    ---------
     explore: Same functionality, but shows the entire area of the geometries.
     clipmap: Same functionality, but shows only the areas clipped by a given mask.
 
-    Examples
-    --------
+    Examples:
+    ---------
     >>> from sgis import read_parquet_url, samplemap
     >>> roads = read_parquet_url("https://media.githubusercontent.com/media/statisticsnorway/ssb-sgis/main/tests/testdata/roads_eidskog_2022.parquet")
     >>> points = read_parquet_url("https://media.githubusercontent.com/media/statisticsnorway/ssb-sgis/main/tests/testdata/points_eidskog.parquet")
@@ -290,78 +294,72 @@ def samplemap(
     >>> samplemap(roads, points, size=5_000, column="meters")
 
     """
-
-    if gdfs and isinstance(gdfs[-1], (float, int)):
+    if gdfs and len(gdfs) > 1 and isinstance(gdfs[-1], (float, int)):
         *gdfs, size = gdfs
 
     gdfs, column, kwargs = Map._separate_args(gdfs, column, kwargs)
 
-    mask, kwargs = _get_location_mask(kwargs | {"size": size}, gdfs)
+    loc_mask, kwargs = _get_location_mask(kwargs | {"size": size}, gdfs)
     kwargs.pop("size")
+    mask = kwargs.pop("mask", loc_mask)
 
-    if explore:
-        m = Explore(
-            *gdfs,
-            column=column,
-            labels=labels,
-            browser=browser,
-            max_zoom=max_zoom,
-            smooth_factor=smooth_factor,
-            **kwargs,
-        )
-        if m.gdfs is None and not len(m.raster_datasets):
-            return
-        if mask is not None:
-            m._gdfs = [gdf.clip(mask) for gdf in m._gdfs]
-            m._gdf = m._gdf.clip(mask)
-            m._nan_idx = m._gdf[m._column].isna()
-            m._get_unique_values()
-
-        m.samplemap(size, sample_from_first=sample_from_first)
+    i = 0 if sample_from_first else random.choice(list(range(len(gdfs))))
+    try:
+        sample = gdfs[i]
+    except IndexError:
+        sample = list(kwargs.values())[i]
 
+    if mask is None:
+        try:
+            sample = sample.geometry.dropna().sample(1)
+        except Exception:
+            try:
+                sample = sample.sample(1)
+            except Exception:
+                pass
+        try:
+            sample = to_gdf(to_shapely(sample)).explode(ignore_index=True)
+        except Exception:
+            sample = to_gdf(to_shapely(to_bbox(sample))).explode(ignore_index=True)
     else:
-        m = Map(
-            *gdfs,
-            column=column,
-            labels=labels,
-            **kwargs,
-        )
-
-        if sample_from_first:
-            sample = m._gdfs[0].sample(1)
-        else:
-            sample = m._gdf.sample(1)
+        try:
+            sample = to_gdf(to_shapely(sample)).explode(ignore_index=True)
+        except Exception:
+            sample = to_gdf(to_shapely(to_bbox(sample))).explode(ignore_index=True)
 
-        # convert lines to polygons
-        if get_geom_type(sample) == "line":
-            sample["geometry"] = sample.buffer(1)
+        sample = sample.clip(mask).sample(1)
 
-        if get_geom_type(sample) == "polygon":
-            random_point = sample.sample_points(size=1)
+    random_point = sample.sample_points(size=1)
 
-        # if point or mixed geometries
-        else:
-            random_point = sample.centroid
+    center = (random_point.geometry.iloc[0].x, random_point.geometry.iloc[0].y)
+    print(f"center={center}, size={size}")
 
-        center = (random_point.geometry.iloc[0].x, random_point.geometry.iloc[0].y)
-        print(f"center={center}, size={size}")
+    mask = random_point.buffer(size)
 
-        m._gdf = m._gdf.clip(random_point.buffer(size))
-
-        qtm(m._gdf, column=m.column, cmap=m._cmap, k=m.k)
+    return clipmap(
+        *gdfs,
+        column=column,
+        mask=mask,
+        browser=browser,
+        max_zoom=max_zoom,
+        explore=explore,
+        smooth_factor=smooth_factor,
+        max_images=max_images,
+        **kwargs,
+    )
 
 
 def clipmap(
     *gdfs: GeoDataFrame,
     column: str | None = None,
     mask: GeoDataFrame | GeoSeries | Geometry = None,
-    labels: tuple[str] | None = None,
     explore: bool = True,
     max_zoom: int = 40,
     smooth_factor: int | float = 1.5,
     browser: bool = False,
+    max_images: int = 15,
     **kwargs,
-) -> None:
+) -> Explore | Map:
     """Shows an interactive map of a of GeoDataFrames clipped to the mask extent.
 
     It takes all the GeoDataFrames specified, clips them to the extent of the mask,
@@ -378,9 +376,6 @@ def clipmap(
         mask: the geometry to clip the data by.
         column: The column to color the geometries by. Defaults to None, which means
             each GeoDataFrame will get a unique color.
-        labels: By default, the GeoDataFrames will be labeled by their object names.
-            Alternatively, labels can be specified as a tuple of strings the same
-            length as the number of gdfs.
         max_zoom: The maximum allowed level of zoom. Higher number means more zoom
             allowed. Defaults to 30, which is higher than the geopandas default.
         smooth_factor: How much to simplify the geometries. 1 is the minimum,
@@ -389,22 +384,29 @@ def clipmap(
             or not in Jupyter, a static plot will be shown.
         browser: If False (default), the maps will be shown in Jupyter.
             If True the maps will be opened in a browser folder.
+        max_images: Maximum number of images (Image, ImageCollection, Band) to show per
+            map. Defaults to 15.
         **kwargs: Keyword arguments to pass to geopandas.GeoDataFrame.explore, for
             instance 'cmap' to change the colors, 'scheme' to change how the data
             is grouped. This defaults to 'fisherjenkssampled' for numeric data.
 
-    See also
-    --------
+    See Also:
+    ---------
     explore: same functionality, but shows the entire area of the geometries.
     samplemap: same functionality, but shows only a random area of a given size.
     """
-
     gdfs, column, kwargs = Map._separate_args(gdfs, column, kwargs)
 
     if mask is None and len(gdfs) > 1:
         mask = gdfs[-1]
         gdfs = gdfs[:-1]
 
+    if not isinstance(mask, (GeoDataFrame | GeoSeries | Geometry | tuple)):
+        try:
+            mask = to_gdf(mask)
+        except Exception:
+            mask = to_shapely(to_bbox(mask))
+
     center = kwargs.pop("center", None)
     size = kwargs.pop("size", None)
 
@@ -412,29 +414,31 @@ def clipmap(
         m = Explore(
             *gdfs,
             column=column,
-            labels=labels,
             browser=browser,
             max_zoom=max_zoom,
             smooth_factor=smooth_factor,
+            max_images=max_images,
             **kwargs,
         )
-        if m.gdfs is None and not len(m.raster_datasets):
-            return
+        m.mask = mask
+
+        if m.gdfs is None and not len(m.rasters):
+            return m
 
         m._gdfs = [gdf.clip(mask) for gdf in m._gdfs]
         m._gdf = m._gdf.clip(mask)
         m._nan_idx = m._gdf[m._column].isna()
         m._get_unique_values()
         m.explore(center=center, size=size)
+        return m
     else:
         m = Map(
             *gdfs,
             column=column,
-            labels=labels,
             **kwargs,
         )
         if m.gdfs is None:
-            return
+            return m
 
         m._gdfs = [gdf.clip(mask) for gdf in m._gdfs]
         m._gdf = m._gdf.clip(mask)
@@ -443,8 +447,10 @@ def clipmap(
 
         qtm(m._gdf, column=m.column, cmap=m._cmap, k=m.k)
 
+        return m
+
 
-def explore_locals(*gdfs, convert: bool = True, **kwargs):
+def explore_locals(*gdfs: GeoDataFrame, convert: bool = True, **kwargs) -> None:
     """Displays all local variables with geometries (GeoDataFrame etc.).
 
     Local means inside a function or file/notebook.
@@ -478,17 +484,17 @@ def explore_locals(*gdfs, convert: bool = True, **kwargs):
 
             if isinstance(value, dict) or hasattr(value, "__dict__"):
                 # add dicts or classes with GeoDataFrames to kwargs
-                for key, value in as_dict(value).items():
-                    if isinstance(value, allowed_types):
-                        gdf = clean_geoms(to_gdf_func(value))
+                for key, val in as_dict(value).items():
+                    if isinstance(val, allowed_types):
+                        gdf = clean_geoms(to_gdf(val))
                         if len(gdf):
                             local_gdfs[key] = gdf
 
-                    elif isinstance(value, dict) or hasattr(value, "__dict__"):
+                    elif isinstance(val, dict) or hasattr(val, "__dict__"):
                         try:
-                            for k, v in value.items():
+                            for k, v in val.items():
                                 if isinstance(v, allowed_types):
-                                    gdf = clean_geoms(to_gdf_func(v))
+                                    gdf = clean_geoms(to_gdf(v))
                                     if len(gdf):
                                         local_gdfs[k] = gdf
                         except Exception:
@@ -497,7 +503,7 @@ def explore_locals(*gdfs, convert: bool = True, **kwargs):
 
                 continue
             try:
-                gdf = clean_geoms(to_gdf_func(value))
+                gdf = clean_geoms(to_gdf(value))
                 if len(gdf):
                     local_gdfs[name] = gdf
                 continue
@@ -512,7 +518,7 @@ def explore_locals(*gdfs, convert: bool = True, **kwargs):
         if not frame:
             break
 
-    explore(*gdfs, **local_gdfs, **kwargs)
+    return explore(*gdfs, **local_gdfs, **kwargs)
 
 
 def qtm(
@@ -543,12 +549,13 @@ def qtm(
             'viridis' when black, and 'RdPu' when white.
         size: Size of the plot. Defaults to 10.
         title_fontsize: Size of the title.
+        legend: Whether to add legend. Defaults to True.
         cmap: Color palette of the map. See:
             https://matplotlib.org/stable/tutorials/colors/colormaps.html
         k: Number of color groups.
         **kwargs: Additional keyword arguments taken by the geopandas plot method.
 
-    See also:
+    See Also:
         ThematicMap: Class with more options for customising the plot.
     """
     gdfs, column, kwargs = Map._separate_args(gdfs, column, kwargs)
@@ -561,9 +568,6 @@ def qtm(
         else:
             new_kwargs[key] = value
 
-            # self.labels.append(key)
-            # self.show.append(last_show)
-
     m = ThematicMap(*gdfs, column=column, size=size, black=black)
 
     if m._gdfs is None: