geoai-py 0.2.1__tar.gz → 0.2.3__tar.gz

{geoai_py-0.2.1 → geoai_py-0.2.3}/.gitignore

@@ -11,6 +11,8 @@ private/
 **/*.las
 *.geojson
 docs/examples/*.md
+*.xml
+docs/examples/output/
 
 # Distribution / packaging
 .Python

{geoai_py-0.2.1 → geoai_py-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: geoai-py
-Version: 0.2.1
+Version: 0.2.3
 Summary: A Python package for using Artificial Intelligence (AI) with geospatial data
 Author-email: Qiusheng Wu <giswqs@gmail.com>
 License: MIT License
@@ -18,11 +18,13 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: albumentations
+Requires-Dist: contextily
 Requires-Dist: geopandas
 Requires-Dist: huggingface_hub
 Requires-Dist: jupyter-server-proxy
 Requires-Dist: leafmap
 Requires-Dist: localtileserver
+Requires-Dist: mapclassify
 Requires-Dist: overturemaps
 Requires-Dist: planetary-computer
 Requires-Dist: pystac-client
@@ -62,6 +64,8 @@ GeoAI bridges the gap between AI and geospatial analysis, providing tools for pr
 
 ## 🚀 Key Features
 
+❗ **Important notes:** The GeoAI package is under active development and new features are being added regularly. Not all features listed below are available in the current release. If you have a feature request or would like to contribute, please let us know!
+
 ### 📊 Advanced Geospatial Data Visualization
 
 -   Interactive multi-layer visualization of vector, raster, and point cloud data

{geoai_py-0.2.1 → geoai_py-0.2.3}/README.md

@@ -18,6 +18,8 @@ GeoAI bridges the gap between AI and geospatial analysis, providing tools for pr
 
 ## 🚀 Key Features
 
+❗ **Important notes:** The GeoAI package is under active development and new features are being added regularly. Not all features listed below are available in the current release. If you have a feature request or would like to contribute, please let us know!
+
 ### 📊 Advanced Geospatial Data Visualization
 
 -   Interactive multi-layer visualization of vector, raster, and point cloud data

geoai_py-0.2.3/docs/examples/building_footprints_usa.ipynb

@@ -0,0 +1,157 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Building Footprint Extraction for the USA\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_usa.ipynb)\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": [
+    "## Download 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/naip_train_buildings.geojson\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "raster_path = geoai.download_file(raster_url)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "vector_path = geoai.download_file(vector_url)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Initialize building footprint extraction pretrained model"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "extractor = geoai.BuildingFootprintExtractor()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Extract building footprints"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "output_path = \"naip_buildings.geojson\"\n",
+    "gdf = extractor.process_raster(raster_path, output_path, batch_size=4)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Visualize building footprints"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "gdf.head()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "gdf.explore()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "torch",
+   "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.11.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

{geoai_py-0.2.1 → geoai_py-0.2.3}/docs/examples/data_visualization.ipynb

@@ -40,7 +40,7 @@
    "source": [
     "from torchgeo.datasets import NAIP\n",
     "from torchgeo.samplers import RandomGeoSampler, GridGeoSampler\n",
-    "from geoai.common import viz_image, viz_raster, dict_to_image\n",
+    "from geoai.common import view_image, view_raster, dict_to_image\n",
     "from geoai.download import download_naip"
    ]
   },
@@ -83,8 +83,8 @@
     "  - **RandomGeoSampler**: Samples random patches from the dataset\n",
     "  - **GridGeoSampler**: Samples patches in a grid pattern with specified stride\n",
     "- **geoai.common**: Custom utility functions for visualization:\n",
-    "  - **viz_image**: Visualizes tensor images\n",
-    "  - **viz_raster**: Displays georeferenced data on an interactive map\n",
+    "  - **view_image**: Visualizes tensor images\n",
+    "  - **view_raster**: Displays georeferenced data on an interactive map\n",
     "  - **dict_to_image**: Converts dictionary representation to image format\n",
     "\n",
     "## Setting Up the Dataset"
@@ -230,7 +230,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "viz_image(\n",
+    "view_image(\n",
     "    train_image, transpose=True, scale_factor=(1 / 250), title=\"Random GeoSampler\"\n",
     ")"
    ]
@@ -307,7 +307,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "viz_image(test_image, transpose=True, scale_factor=(1 / 250), title=\"Grid GeoSampler\")"
+    "view_image(test_image, transpose=True, scale_factor=(1 / 250), title=\"Grid GeoSampler\")"
    ]
   },
   {
@@ -343,7 +343,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "viz_raster(data, basemap=\"Google Satellite\")"
+    "view_raster(data, basemap=\"Google Satellite\")"
    ]
   },
   {
@@ -356,7 +356,7 @@
     "\n",
     "1. **TorchGeo** provides a flexible framework for working with geospatial datasets like NAIP.\n",
     "2. Different sampling strategies (random vs. grid) serve different purposes in geospatial machine learning workflows.\n",
-    "3. Visualization tools help understand the data in both pixel space (viz_image) and geographic space (viz_raster).\n",
+    "3. Visualization tools help understand the data in both pixel space (view_image) and geographic space (view_raster).\n",
     "4. Working with geospatial data requires attention to coordinate reference systems (CRS) and proper handling of georeferenced data."
    ]
   }

geoai_py-0.2.3/docs/examples/image_chips.ipynb

@@ -0,0 +1,235 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Generate Image Chips\n",
+    "\n",
+    "[![image](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/opengeos/geoai/blob/main/docs/examples/image_chips.ipynb)\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 Packages"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import geoai"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Download 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/naip_train_buildings.geojson\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "raster_path = geoai.download_file(raster_url)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "vector_path = geoai.download_file(vector_url)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Preview data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_image(raster_path, figsize=(18, 10))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_vector(vector_path, basemap=True, alpha=0.5, figsize=(18, 10))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_vector_interactive(vector_path)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Convert vector to raster"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "output_path = vector_path.replace(\".geojson\", \".tif\")\n",
+    "geoai.vector_to_raster(vector_path, output_path, reference_raster=raster_path)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_image(output_path, figsize=(18, 10))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Generate image chips"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "tiles = geoai.export_geotiff_tiles(\n",
+    "    in_raster=raster_path,\n",
+    "    out_folder=\"output\",\n",
+    "    in_class_data=vector_path,\n",
+    "    tile_size=512,\n",
+    "    stride=256,\n",
+    "    buffer_radius=0,\n",
+    "    create_overview=True,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Preview image chips"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_image(\"output/overview.png\", figsize=(18, 10))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_image(\"output/images/tile_000000.tif\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_image(\"output/labels/tile_000000.tif\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_image(\"output/images/tile_000001.tif\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "geoai.view_image(\"output/labels/tile_000001.tif\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "torch",
+   "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.11.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}