Skip to main content

An open-source object-based image analysis library for remote sensing.

Project description

NickySpatial

An open-source object-based image analysis library for remote sensing.

Category Badge
Build uv hatchling pre-commit.ci status
Code Quality Ruff pre-commit Tests Coverage
Documentation MkDocs Read DeepWiki
Package Info Python PyPI version Dependencies License
Community GitHub Stars Issues Downloads Last Commit

[!WARNING] This project is under active development and lot of its functionality is still in my head yet to code.

Find Demo Frontend Here : https://nickyspatial-gpoqz.ondigitalocean.app/

Description

NickySpatial is a Python package that provides object-based image analysis (OBIA) functionality similar to commercial software like eCognition. It allows users to segment geospatial imagery into meaningful objects, calculate statistics, and apply rule-based classification.

Project Structure

nickyspatial/
├── __init__.py
├── io/
   ├── __init__.py
   ├── raster.py       # Raster I/O
   └── vector.py       # Vector I/O
├── core/
   ├── __init__.py
   ├── layer.py        # Layer class and management
   ├── segmentation.py # Segmentation algorithms
   └── rules.py        # Rule engine
|   └── classifier.py   # Classification algorithms
├── stats/
   ├── __init__.py
   ├── basic.py        # Basic statistics (min, max, mean, etc.)
   ├── spatial.py      # Spatial statistics (area, perimeter, etc.)
   └── spectral.py     # Spectral indices (NDVI, etc.)
├── filters/
   ├── __init__.py
   ├── spatial.py      # Spatial filters (smoothing, merging)
   └── spectral.py     # Spectral filters (band math)
├── viz/
   ├── __init__.py
   ├── maps.py         # Map visualization
   └── charts.py       # Statistical charts
└── utils/
    ├── __init__.py
    └── helpers.py      # Helper functions

Installation

pip install nickyspatial

Quick Start

import nickyspatial as ns
 TODO : add sample computation here

Documentation

For detailed documentation and examples, see the documentation website. Deepwiki also provides documentation quite detailed , Do check it out if you like

Examples

Check out the 'examples' directory for more examples:

TODO : Add example scripts here

Contributing

Contributions are welcome! Follow dev setup guide & Please feel free to submit a Pull Request.

Acknowledgments

  • Inspired by the functionality of eCognition and other OBIA methodologies
  • Built on top of powerful open-source libraries like numpy, rasterio, scikit-image, and GeoPandas
  • Nicky : Nicky is my belated dog and I named this package in his memory!

    Nicky the dog

Contributors

Contributors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nickyspatial-1.0.0.tar.gz (10.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nickyspatial-1.0.0-py3-none-any.whl (34.7 kB view details)

Uploaded Python 3

File details

Details for the file nickyspatial-1.0.0.tar.gz.

File metadata

  • Download URL: nickyspatial-1.0.0.tar.gz
  • Upload date:
  • Size: 10.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.4

File hashes

Hashes for nickyspatial-1.0.0.tar.gz
Algorithm Hash digest
SHA256 aef4ec6a58472a05fefc579e693e82d6de9f9106cbbf16cbb2b6801e2a7d0c84
MD5 56fb71c544613e213d2bb6fa88206ab6
BLAKE2b-256 e8f2f92b9843ee19467e0a3e844b525767ce25733f0079f967d80b422d436235

See more details on using hashes here.

File details

Details for the file nickyspatial-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nickyspatial-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f0bed2d0ca23e35fe553d2270c8b057cd473f2e65824ab538d480b620a395dc
MD5 8f42d2a93e2b95e97dfd28e1cd3b4a33
BLAKE2b-256 e456f2effba0c8fafcabc81928060904ea083af0d3069e30bde36c6d51d03ba7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page