feat: OSM Tile Loader

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- SlippyMapRegionizer
+- OSMTileLoader
 - GTFS Loader from gtfs2vec paper
 - GTFS2Vec Model from gtfs2vec paper
 - GTFS2Vec Embedder using gtfs2vec model

examples/loaders/osm_tile_loader.ipynb

@@ -0,0 +1,114 @@
+{
+ "cells": [
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# OSM Tile Loader"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from srai.loaders.osm_loaders import OSMTileLoader\n",
+    "from srai.utils import geocode_to_region_gdf\n",
+    "\n",
+    "ZOOM = 9"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Get tiles from tile server"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "In order to get tiles use load method. Method `load` returns `GeoDataFrame` object with images or path to them, as chosen data_collector. Returned frame contains  also geographical coordinates of tile and x, y, z coordinates used by tile servers."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "loader = OSMTileLoader(\"https://tile.openstreetmap.de\", zoom=ZOOM, verbose=True)\n",
+    "gdf = geocode_to_region_gdf(\"Wroclaw, Poland\")\n",
+    "tiles = loader.load(gdf)\n",
+    "tiles"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "To get records conveniently use SlippyMapId"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "tiles.loc[f\"279_170_{ZOOM}\"][\"tile\"]"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Get one tile"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "loader = OSMTileLoader(\"https://tile.openstreetmap.de\", zoom=2)\n",
+    "tile = loader.get_tile_by_x_y(2, 1)\n",
+    "tile"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3.10.9 ('nlp_venv')",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.10"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "685727852e42551632e0fc1e43e361d886b7ddaddaf1474b2acdf6903161a758"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

examples/regionizers/slippy_map_regionizer.ipynb

@@ -0,0 +1,129 @@
+{
+ "cells": [
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Slippy Map Regionizer Example"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import geopandas as gpd\n",
+    "from shapely import geometry\n",
+    "\n",
+    "from srai.regionizers import SlippyMapRegionizer\n",
+    "from srai.plotting.folium_wrapper import plot_regions\n",
+    "from srai.constants import WGS84_CRS"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Define starting polygons"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "gdf = gpd.GeoDataFrame(\n",
+    "    geometry=[\n",
+    "        geometry.Polygon(\n",
+    "            shell=[\n",
+    "                (-1, 0),\n",
+    "                (0, 0.5),\n",
+    "                (1, 0),\n",
+    "                (1, 1),\n",
+    "                (0, 1),\n",
+    "            ],\n",
+    "            holes=[\n",
+    "                [\n",
+    "                    (0.8, 0.9),\n",
+    "                    (0.9, 0.55),\n",
+    "                    (0.8, 0.3),\n",
+    "                    (0.5, 0.4),\n",
+    "                ]\n",
+    "            ],\n",
+    "        ),\n",
+    "        geometry.Polygon(shell=[(-0.25, 0), (0.25, 0), (0, 0.2)]),\n",
+    "    ],\n",
+    "    crs=WGS84_CRS,\n",
+    ")\n",
+    "gdf.explore()"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Define tile resolution"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "zoom = 12"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Regionize using SlippyMapRegionizer"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "regionizer = SlippyMapRegionizer(zoom)\n",
+    "gdf_slippy = regionizer.transform(gdf)\n",
+    "\n",
+    "folium_map = gdf.explore()\n",
+    "plot_regions(gdf_slippy, colormap=[\"red\"], map=folium_map)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3.10.10 ('.venv': venv)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.16"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "bef431f694ba250a61f6c29f974e05c16577f910a5abf521c495f491290a7f34"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

pyproject.toml

@@ -19,6 +19,7 @@ dependencies = [
     "tqdm",
     "s2",
     "typeguard",
+    "requests",
 ]
 requires-python = ">=3.8"
 readme = "README.md"
@@ -52,7 +53,7 @@ Changelog = "https://github.com/srai-lab/srai/blob/main/CHANGELOG.md"
 # add tests
 
 # pdm add -G osm <library>
-osm = ["osmium", "osmnx", "overpass"]
+osm = ["osmium", "osmnx", "overpass", "pillow"]
 # pdm add -G voronoi <library>
 voronoi = ["pymap3d", "haversine", "spherical-geometry"]
 # pdm add -G gtfs <library>

srai/loaders/__init__.py

@@ -9,7 +9,7 @@
 from ._base import Loader
 from .geoparquet_loader import GeoparquetLoader
 from .gtfs_loader import GTFSLoader
-from .osm_loaders import OSMLoader, OSMOnlineLoader, OSMPbfLoader
+from .osm_loaders import OSMLoader, OSMOnlineLoader, OSMPbfLoader, OSMTileLoader
 from .osm_way_loader import OSMWayLoader
 
 __all__ = [
@@ -20,4 +20,5 @@
     "OSMWayLoader",
     "OSMOnlineLoader",
     "OSMPbfLoader",
+    "OSMTileLoader",
 ]

srai/loaders/osm_loaders/__init__.py

@@ -3,5 +3,6 @@
 from ._base import OSMLoader
 from .osm_online_loader import OSMOnlineLoader
 from .osm_pbf_loader import OSMPbfLoader
+from .osm_tile_loader import OSMTileLoader
 
-__all__ = ["OSMLoader", "OSMOnlineLoader", "OSMPbfLoader"]
+__all__ = ["OSMLoader", "OSMOnlineLoader", "OSMPbfLoader", "OSMTileLoader"]