Created using Colab

Author: Jsdogbey

docs/examples/building_footprints_africa.ipynb

@@ -0,0 +1,247 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "kTSAeTDH-vc0"
+      },
+      "source": [
+        "# Building Footprint Extraction for Africa\n",
+        "\n",
+        "[![image](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/opengeos/geoai/blob/main/docs/examples/building_footprints_africa.ipynb)\n",
+        "\n",
+        "## Install package\n",
+        "\n",
+        "To use the `geoai-py` package, ensure it is installed in your environment. Uncomment the command below if needed."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "from google.colab import drive\n",
+        "drive.mount('/content/drive')"
+      ],
+      "metadata": {
+        "id": "kqLaOExU-1yU"
+      },
+      "execution_count": null,
+      "outputs": []
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "NVGHK7TR-vc2"
+      },
+      "outputs": [],
+      "source": [
+        "# %pip install geoai-py"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "N1ePOZwo-vc4"
+      },
+      "source": [
+        "## Import libraries"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "pFiOKWJi-vc5"
+      },
+      "outputs": [],
+      "source": [
+        "import geoai"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "ehQxMXyb-vc6"
+      },
+      "source": [
+        "## Download sample data"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "SRDRFzjl-vc7"
+      },
+      "outputs": [],
+      "source": [
+        "raster_url = \"https://huggingface.co/datasets/giswqs/geospatial/resolve/main/buildings_africa.tif\""
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "EvkEbTqN-vc_"
+      },
+      "outputs": [],
+      "source": [
+        "raster_path = geoai.download_file(raster_url)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "o9xSPTuI-vc_"
+      },
+      "source": [
+        "## Initialize the model"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "0PF5gXpN-vdA"
+      },
+      "outputs": [],
+      "source": [
+        "extractor = geoai.BuildingFootprintExtractor(model_path=\"building_footprints_usa.pth\")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "oBJCKHgj-vdA"
+      },
+      "source": [
+        "## Extract building footprints"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "vz6u753Y-vdB"
+      },
+      "outputs": [],
+      "source": [
+        "masks_path = extractor.generate_masks(\n",
+        "    raster_path,\n",
+        "    output_dir=\"building_masks.tif\",\n",
+        "    min_object_area=1000,\n",
+        "    confidence_threshold=0.5,\n",
+        "    threshold=0.5,\n",
+        ")"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "c2QcZPgo-vdB"
+      },
+      "outputs": [],
+      "source": [
+        "geoai.view_raster(masks_path, opacity=0.7, colormap=\"tab20\", basemap=raster_url)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "WIuPFC4q-vdB"
+      },
+      "source": [
+        "## Vectorize masks"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "LKe5g2ou-vdC"
+      },
+      "outputs": [],
+      "source": [
+        "gdf = geoai.orthogonalize(\n",
+        "    input_path=masks_path, output_path=\"building_footprints.geojson\", epsilon=1.0\n",
+        ")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "5fde0oT2-vdC"
+      },
+      "source": [
+        "## Add geometric attributes"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "T3i6tBjO-vdC"
+      },
+      "outputs": [],
+      "source": [
+        "gdf = geoai.add_geometric_properties(gdf)"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "qwo5iPwB-vdC"
+      },
+      "source": [
+        "## Visualize results"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "id": "GahTxmTn-vdD"
+      },
+      "outputs": [],
+      "source": [
+        "geoai.view_vector_interactive(\n",
+        "    gdf, style_kwds={\"color\": \"red\", \"fillOpacity\": 0.2}, tiles=raster_url\n",
+        ")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {
+        "id": "orojwF0k-vdD"
+      },
+      "source": [
+        "![image](https://github.com/user-attachments/assets/8c651e7d-b2c3-4bb4-871e-4317cd1444a1)"
+      ]
+    }
+  ],
+  "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"
+    },
+    "colab": {
+      "provenance": []
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}