geoai-py 0.5.3__tar.gz → 0.5.4__tar.gz

{geoai_py-0.5.3 → geoai_py-0.5.4}/.github/workflows/docs-build.yml

@@ -35,6 +35,7 @@ jobs:
               run: |
                   uv pip install --find-links https://girder.github.io/large_image_wheels GDAL pyproj
                   uv pip install pytest
+                  uv pip install "geoai-py[extra]"
 
             - name: Test import
               run: |

{geoai_py-0.5.3 → geoai_py-0.5.4}/.github/workflows/docs.yml

@@ -34,6 +34,7 @@ jobs:
               run: |
                   uv pip install --find-links https://girder.github.io/large_image_wheels GDAL pyproj
                   uv pip install pytest
+                  uv pip install "geoai-py[extra]"
 
             - name: Test import
               run: |

{geoai_py-0.5.3 → geoai_py-0.5.4}/.github/workflows/ubuntu.yml

@@ -14,7 +14,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                python-version: ["3.9", "3.10", "3.11", "3.12"]
+                python-version: ["3.10", "3.11", "3.12"]
 
         steps:
             - uses: actions/checkout@v4
@@ -37,6 +37,7 @@ jobs:
               run: |
                   uv pip install --find-links https://girder.github.io/large_image_wheels gdal pyproj
                   uv pip install pytest
+                  uv pip install "geoai-py[extra]"
 
             - name: Test import
               run: |

{geoai_py-0.5.3 → geoai_py-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geoai-py
-Version: 0.5.3
+Version: 0.5.4
 Summary: A Python package for using Artificial Intelligence (AI) with geospatial data
 Author-email: Qiusheng Wu <giswqs@gmail.com>
 License: MIT License
@@ -9,15 +9,15 @@ Keywords: geoai
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: albumentations
+Requires-Dist: buildingregulariser
 Requires-Dist: contextily
 Requires-Dist: geopandas
 Requires-Dist: huggingface_hub

geoai_py-0.5.4/docs/examples/regularization.ipynb

@@ -0,0 +1,185 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Regularization\n",
+    "\n",
+    "[![image](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/opengeos/geoai/blob/main/docs/examples/regularization.ipynb)\n",
+    "\n",
+    "This example demonstrates how to regularize building footprints using the `regularize` function from the `geoai` package. The function is a wrapper around the `regularize_geodataframe` function from the [buildingregulariser](https://github.com/DPIRD-DMA/Building-Regulariser) package. Credits to the original author, Nick Wright.\n",
+    "\n",
+    "It can be used to regularize features such as building footprints, solar panels, cars, and other objects that have a regular shape.\n",
+    "\n",
+    "## Install package\n",
+    "To use the `geoai-py` package, ensure it is installed in your environment. Uncomment the command below if needed."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# %pip install geoai-py"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Import libraries"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import geoai"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Use sample data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "raster_url = (\n",
+    "    \"https://huggingface.co/datasets/giswqs/geospatial/resolve/main/naip_train.tif\"\n",
+    ")\n",
+    "vector_url = \"https://huggingface.co/datasets/giswqs/geospatial/resolve/main/buildings_original.geojson\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Visualize data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_vector_interactive(vector_url, tiles=raster_url)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Regularize buildings"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "gdf = geoai.regularize(\n",
+    "    data=vector_url,\n",
+    "    simplify_tolerance=2.0,\n",
+    "    allow_45_degree=True,\n",
+    "    diagonal_threshold_reduction=30,\n",
+    "    allow_circles=True,\n",
+    "    circle_threshold=0.9,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_vector_interactive(gdf, tiles=raster_url)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.create_split_map(\n",
+    "    left_layer=gdf,\n",
+    "    right_layer=raster_url,\n",
+    "    left_label=\"Regularized Buildings\",\n",
+    "    right_label=\"NAIP Imagery\",\n",
+    "    left_args={\"style\": {\"color\": \"red\", \"fillOpacity\": 0.3}},\n",
+    "    basemap=raster_url,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Compare results"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import leafmap.foliumap as leafmap"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "m = leafmap.Map()\n",
+    "m.add_cog_layer(raster_url, name=\"NAIP\")\n",
+    "m.add_vector(\n",
+    "    vector_url, style={\"color\": \"yellow\", \"fillOpacity\": 0}, layer_name=\"Original\"\n",
+    ")\n",
+    "m.add_gdf(gdf, style={\"color\": \"red\", \"fillOpacity\": 0}, layer_name=\"Regularized\")\n",
+    "legend = {\n",
+    "    \"Original\": \"yellow\",\n",
+    "    \"Regularized\": \"red\",\n",
+    "}\n",
+    "m.add_legend(title=\"Building Footprints\", legend_dict=legend)\n",
+    "m"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "geo",
+   "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.12.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

{geoai_py-0.5.3 → geoai_py-0.5.4}/geoai/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = """Qiusheng Wu"""
 __email__ = "giswqs@gmail.com"
-__version__ = "0.5.3"
+__version__ = "0.5.4"
 
 
 import os

{geoai_py-0.5.3 → geoai_py-0.5.4}/geoai/utils.py

@@ -6249,3 +6249,99 @@ def download_model_from_hf(model_path, repo_id=None):
         print(f"Error downloading model from Hugging Face: {e}")
         print("Please specify a local model path or ensure internet connectivity.")
         raise
+
+
+def regularize(
+    data: Union[gpd.GeoDataFrame, str],
+    parallel_threshold: float = 1.0,
+    target_crs: Optional[Union[str, "pyproj.CRS"]] = None,
+    simplify: bool = True,
+    simplify_tolerance: float = 0.5,
+    allow_45_degree: bool = True,
+    diagonal_threshold_reduction: float = 15,
+    allow_circles: bool = True,
+    circle_threshold: float = 0.9,
+    num_cores: int = 1,
+    include_metadata: bool = False,
+    output_path: Optional[str] = None,
+    **kwargs,
+) -> gpd.GeoDataFrame:
+    """Regularizes polygon geometries in a GeoDataFrame by aligning edges.
+
+    Aligns edges to be parallel or perpendicular (optionally also 45 degrees)
+    to their main direction. Handles reprojection, initial simplification,
+    regularization, geometry cleanup, and parallel processing.
+
+    This function is a wrapper around the `regularize_geodataframe` function
+    from the `buildingregulariser` package. Credits to the original author
+    Nick Wright. Check out the repo at https://github.com/DPIRD-DMA/Building-Regulariser.
+
+    Args:
+        data (Union[gpd.GeoDataFrame, str]): Input GeoDataFrame with polygon or multipolygon geometries,
+            or a file path to the GeoDataFrame.
+        parallel_threshold (float, optional): Distance threshold for merging nearly parallel adjacent edges
+            during regularization. Defaults to 1.0.
+        target_crs (Optional[Union[str, "pyproj.CRS"]], optional): Target Coordinate Reference System for
+            processing. If None, uses the input GeoDataFrame's CRS. Processing is more reliable in a
+            projected CRS. Defaults to None.
+        simplify (bool, optional): If True, applies initial simplification to the geometry before
+            regularization. Defaults to True.
+        simplify_tolerance (float, optional): Tolerance for the initial simplification step (if `simplify`
+            is True). Also used for geometry cleanup steps. Defaults to 0.5.
+        allow_45_degree (bool, optional): If True, allows edges to be oriented at 45-degree angles relative
+            to the main direction during regularization. Defaults to True.
+        diagonal_threshold_reduction (float, optional): Reduction factor in degrees to reduce the likelihood
+            of diagonal edges being created. Larger values reduce the likelihood of diagonal edges.
+            Defaults to 15.
+        allow_circles (bool, optional): If True, attempts to detect polygons that are nearly circular and
+            replaces them with perfect circles. Defaults to True.
+        circle_threshold (float, optional): Intersection over Union (IoU) threshold used for circle detection
+            (if `allow_circles` is True). Value between 0 and 1. Defaults to 0.9.
+        num_cores (int, optional): Number of CPU cores to use for parallel processing. If 1, processing is
+            done sequentially. Defaults to 1.
+        include_metadata (bool, optional): If True, includes metadata about the regularization process in the
+            output GeoDataFrame. Defaults to False.
+        output_path (Optional[str], optional): Path to save the output GeoDataFrame. If None, the output is
+            not saved. Defaults to None.
+        **kwargs: Additional keyword arguments to pass to the `to_file` method when saving the output.
+
+    Returns:
+        gpd.GeoDataFrame: A new GeoDataFrame with regularized polygon geometries. Original attributes are
+        preserved. Geometries that failed processing might be dropped.
+
+    Raises:
+        ValueError: If the input data is not a GeoDataFrame or a file path, or if the input GeoDataFrame is empty.
+    """
+    try:
+        from buildingregulariser import regularize_geodataframe
+    except ImportError:
+        install_package("buildingregulariser")
+        from buildingregulariser import regularize_geodataframe
+
+    if isinstance(data, str):
+        data = gpd.read_file(data)
+    elif not isinstance(data, gpd.GeoDataFrame):
+        raise ValueError("Input data must be a GeoDataFrame or a file path.")
+
+    # Check if the input data is empty
+    if data.empty:
+        raise ValueError("Input GeoDataFrame is empty.")
+
+    gdf = regularize_geodataframe(
+        data,
+        parallel_threshold=parallel_threshold,
+        target_crs=target_crs,
+        simplify=simplify,
+        simplify_tolerance=simplify_tolerance,
+        allow_45_degree=allow_45_degree,
+        diagonal_threshold_reduction=diagonal_threshold_reduction,
+        allow_circles=allow_circles,
+        circle_threshold=circle_threshold,
+        num_cores=num_cores,
+        include_metadata=include_metadata,
+    )
+
+    if output_path:
+        gdf.to_file(output_path, **kwargs)
+
+    return gdf

{geoai_py-0.5.3 → geoai_py-0.5.4}/geoai_py.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geoai-py
-Version: 0.5.3
+Version: 0.5.4
 Summary: A Python package for using Artificial Intelligence (AI) with geospatial data
 Author-email: Qiusheng Wu <giswqs@gmail.com>
 License: MIT License
@@ -9,15 +9,15 @@ Keywords: geoai
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: albumentations
+Requires-Dist: buildingregulariser
 Requires-Dist: contextily
 Requires-Dist: geopandas
 Requires-Dist: huggingface_hub

{geoai_py-0.5.3 → geoai_py-0.5.4}/geoai_py.egg-info/SOURCES.txt

@@ -54,6 +54,7 @@ docs/examples/image_chips.ipynb
 docs/examples/jupytext.toml
 docs/examples/parking_spot_detection.ipynb
 docs/examples/planetary_computer.ipynb
+docs/examples/regularization.ipynb
 docs/examples/ship_detection.ipynb
 docs/examples/solar_panel_detection.ipynb
 docs/examples/text_prompt_segmentation.ipynb

{geoai_py-0.5.3 → geoai_py-0.5.4}/geoai_py.egg-info/requires.txt

@@ -1,4 +1,5 @@
 albumentations
+buildingregulariser
 contextily
 geopandas
 huggingface_hub

{geoai_py-0.5.3 → geoai_py-0.5.4}/mkdocs.yml

@@ -47,20 +47,21 @@ plugins:
     - mkdocs-jupyter:
           include_source: True
           ignore_h1_titles: True
-          execute: false
+          execute: true
           allow_errors: false
           ignore: ["conf.py"]
-          execute_ignore: [
+          execute_ignore:
+              [
                   "examples/dataviz/*.ipynb",
                   "examples/rastervision/*.ipynb",
                   "examples/samgeo/*.ipynb",
+                  "examples/download_*.ipynb",
+                  "examples/planetary_computer.ipynb",
+                  "examples/*_detection.ipynb",
+                  "examples/building_footprints_*.ipynb",
                   "examples/data_visualization.ipynb",
-                  "examples/download_data.ipynb",
-                  "examples/car_detection.ipynb",
-                  "examples/ship_detection.ipynb",
-                  #   "examples/solar_panel_detection.ipynb",
-                  "examples/building_footprints_africa.ipynb",
-                  "examples/building_footprints_china.ipynb",
+                  "examples/train_*.ipynb",
+                  "examples/wetland_mapping.ipynb",
               ]
     # - mkdocstrings:
     #       default_handler: python
@@ -124,6 +125,7 @@ nav:
           - examples/train_ship_detection.ipynb
           - examples/train_water_detection.ipynb
           - examples/wetland_mapping.ipynb
+          - examples/regularization.ipynb
           #   - examples/samgeo/satellite.ipynb
           #   - examples/samgeo/automatic_mask_generator.ipynb
           #   - examples/samgeo/automatic_mask_generator_hq.ipynb

{geoai_py-0.5.3 → geoai_py-0.5.4}/pyproject.toml

@@ -1,12 +1,12 @@
 [project]
 name = "geoai-py"
-version = "0.5.3"
+version = "0.5.4"
 dynamic = [
     "dependencies",
 ]
 description = "A Python package for using Artificial Intelligence (AI) with geospatial data"
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 keywords = [
     "geoai",
 ]
@@ -18,7 +18,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -44,7 +43,7 @@ universal = true
 
 
 [tool.bumpversion]
-current_version = "0.5.3"
+current_version = "0.5.4"
 commit = true
 tag = true
 

{geoai_py-0.5.3 → geoai_py-0.5.4}/requirements.txt

@@ -1,4 +1,5 @@
 albumentations
+buildingregulariser
 contextily
 geopandas
 huggingface_hub