segment-geospatial

A Python package for segmenting geospatial data with the Segment Anything Model (SAM)

Introduction

The segment-geospatial package draws its inspiration from segment-anything-eo repository authored by Aliaksandr Hancharenka. To facilitate the use of the Segment Anything Model (SAM) for geospatial data, I have developed the segment-anything-py and segment-geospatial Python packages, which are now available on PyPI and conda-forge. My primary objective is to simplify the process of leveraging SAM for geospatial data analysis by enabling users to achieve this with minimal coding effort. I have adapted the source code of segment-geospatial from the segment-anything-eo repository, and credit for its original version goes to Aliaksandr Hancharenka.

• Free software: MIT license
• Documentation: https://samgeo.gishub.org

Citations

• Wu, Q., & Osco, L. (2023). samgeo: A Python package for segmenting geospatial data with the Segment Anything Model (SAM). Journal of Open Source Software, 8(89), 5663, https://doi.org/10.21105/joss.05663

Features

• Download map tiles from Tile Map Service (TMS) servers and create GeoTIFF files
• Segment GeoTIFF files using the Segment Anything Model (SAM) and HQ-SAM
• Segment remote sensing imagery with text prompts
• Create foreground and background markers interactively
• Load existing markers from vector datasets
• Save segmentation results as common vector formats (GeoPackage, Shapefile, GeoJSON)
• Save input prompts as GeoJSON files
• Visualize segmentation results on interactive maps

Installation

Install from PyPI

segment-geospatial is available on PyPI. To install segment-geospatial, run this command in your terminal:

pip install segment-geospatial

Install from conda-forge

segment-geospatial is also available on conda-forge. If you have Anaconda or Miniconda installed on your computer, you can install segment-geospatial using the following commands. It is recommended to create a fresh conda environment for segment-geospatial. The following commands will create a new conda environment named geo and install segment-geospatial and its dependencies:

conda create -n geo python
conda activate geo
conda install -c conda-forge mamba
mamba install -c conda-forge segment-geospatial

If your system has a GPU, but the above commands do not install the GPU version of pytorch, you can force the installation of the GPU version of pytorch using the following command:

mamba install -c conda-forge segment-geospatial "pytorch=*=cuda*"

Samgeo-geospatial has some optional dependencies that are not included in the default conda environment. To install these dependencies, run the following command:

```bash
mamba install -c conda-forge groundingdino-py segment-anything-fast

As of July 9th, 2023 Linux systems have also required that libgl1 be installed for segment-geospatial to work. The following command will install that dependency

apt update; apt install -y libgl1

Examples

• Segmenting remote sensing imagery
• Automatically generating object masks
• Segmenting remote sensing imagery with input prompts
• Segmenting remote sensing imagery with box prompts
• Segmenting remote sensing imagery with text prompts
• Batch segmentation with text prompts
• Using segment-geospatial with ArcGIS Pro
• Segmenting swimming pools with text prompts
• Segmenting satellite imagery from the Maxar Open Data Program

Demos

• Automatic mask generator

• Interactive segmentation with input prompts

• Input prompts from existing files

• Interactive segmentation with text prompts

Tutorials

Video tutorials are available on my YouTube Channel.

• Automatic mask generation

• Using SAM with ArcGIS Pro

• Interactive segmentation with text prompts

Using SAM with Desktop GIS

• QGIS: Check out the Geometric Attributes plugin for QGIS. Credit goes to Bjorn Nyberg.
• ArcGIS: Check out the Segment Anything Model (SAM) Toolbox for ArcGIS and the Resources for Unlocking the Power of Deep Learning Applications Using ArcGIS. Credit goes to Esri.

Computing Resources

The Segment Anything Model is computationally intensive, and a powerful GPU is recommended to process large datasets. It is recommended to have a GPU with at least 8 GB of GPU memory. You can utilize the free GPU resources provided by Google Colab. Alternatively, you can apply for AWS Cloud Credit for Research, which offers cloud credits to support academic research. If you are in the Greater China region, apply for the AWS Cloud Credit here.

Legal Notice

This repository and its content are provided for educational purposes only. By using the information and code provided, users acknowledge that they are using the APIs and models at their own risk and agree to comply with any applicable laws and regulations. Users who intend to download a large number of image tiles from any basemap are advised to contact the basemap provider to obtain permission before doing so. Unauthorized use of the basemap or any of its components may be a violation of copyright laws or other applicable laws and regulations.

Contributing

Please refer to the contributing guidelines for more information.

Acknowledgements

This project is based upon work partially supported by the National Aeronautics and Space Administration (NASA) under Grant No. 80NSSC22K1742 issued through the Open Source Tools, Frameworks, and Libraries 2020 Program.

This project is also supported by Amazon Web Services (AWS). In addition, this package was made possible by the following open source projects. Credit goes to the developers of these projects.

• segment-anything
• segment-anything-eo
• tms2geotiff
• GroundingDINO
• lang-segment-anything