Skip to main content

A python library for efficient processing of spectral images.

Project description

Sublime's custom image

Spectral imaging analysis for Python (SiaPy) is a tool for efficient processing of spectral images

Test Coverage Package version DOI Supported Python versions


Source Code: https://github.com/siapy/siapy-lib

Bug Report / Feature Request: https://github.com/siapy/siapy-lib/issues/new/choose

Documentation: https://siapy.github.io/siapy-lib/


📚 Overview

SiaPy is a versatile Python library designed for processing and analyzing spectral images. It is particularly useful for scientific and academic purposes, but it also serves well for quick prototyping.

Key Features

  • Image Processing: Easily read, display, and manipulate spectral image data.
  • Data Analysis: Perform in-depth analysis of spectral signatures using advanced analytical techniques.
  • Machine Learning Integration: Select image regions for training models and segment images using pre-trained models.
  • Camera Co-registration: Align multiple cameras and compute transformations across different camera spaces.
  • Radiometric Conversion: Convert radiance to reflectance using reference panels.

To make some of the functionality more easily accessible, a command line interface (CLI) is also provided. See siapy-cli. However, the full functionality can be exploited by using the library directly.

💡 Installation

To install the siapy library, use the following command:

pip install siapy

For detailed information and additional options, please refer to the instructions.

💻 Examples

from pathlib import Path
from siapy.entities import SpectralImageSet

data_dir = "~/data"

header_paths = sorted(Path(data_dir).rglob("*.hdr"))
image_paths = sorted(Path(data_dir).rglob("*.img"))

imageset = SpectralImageSet.spy_open(
    header_paths=header_paths,
    image_paths=image_paths,
)
print(imageset)

For an overview of the key concepts and functionalities of the SiaPy library, please refer to the documentation. Additionally, explore the use cases that demonstrate the library's capabilities here.

🔍 Contribution guidelines

We always welcome small improvements or fixes. If you’re considering making more significant contributions to the source code, please contact us via email.

Contributing to SiaPy isn’t limited to coding. You can also:

  • Help us manage and resolve issues, both new and existing.
  • Create tutorials, presentations, and other educational resources.
  • Propose new features.

Not sure where to start or how your skills might fit in? Don’t hesitate to reach out! You can contact us via email, or connect with us directly on GitHub by opening a new issue or commenting on an existing one.

If you’re new to open-source contributions, check out our guide for helpful tips on getting started.

🕐 Issues and new features

Encountered a problem with the library? Please report it by creating an issue on GitHub.

Interested in fixing an issue or enhancing the library’s functionality? Fork the repository, make your changes, and submit a pull request on GitHub.

Have a question? First, ensure that the setup process was completed successfully and resolve any related issues. If you’ve pulled in newer code, you might need to delete and recreate your SiaPy environment to ensure all the necessary packages are correctly installed.

🤝 License

This project is licensed under the MIT License. See LICENSE for more details.

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

siapy-0.9.7.tar.gz (7.4 MB view details)

Uploaded Source

Built Distribution

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

siapy-0.9.7-py3-none-any.whl (66.7 kB view details)

Uploaded Python 3

File details

Details for the file siapy-0.9.7.tar.gz.

File metadata

  • Download URL: siapy-0.9.7.tar.gz
  • Upload date:
  • Size: 7.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.25.2 CPython/3.12.11 Linux/6.11.0-1015-azure

File hashes

Hashes for siapy-0.9.7.tar.gz
Algorithm Hash digest
SHA256 ef0b58f7b3e7d2d83493d95543a3428edd7a39c6f976f5342a977241c3bc0fe9
MD5 b1106af346ce405c648b7ad582e7a008
BLAKE2b-256 8cdda8cb4397c60da64b4b79ebea246eb99651f1b741d6f0542de0657079e13a

See more details on using hashes here.

File details

Details for the file siapy-0.9.7-py3-none-any.whl.

File metadata

  • Download URL: siapy-0.9.7-py3-none-any.whl
  • Upload date:
  • Size: 66.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.25.2 CPython/3.12.11 Linux/6.11.0-1015-azure

File hashes

Hashes for siapy-0.9.7-py3-none-any.whl
Algorithm Hash digest
SHA256 bd8d316ed64698014f019db1daf816d0e7a60e9955d6159bf234b3e616ae0936
MD5 ea03025adacdab5aada7e00f80f0201a
BLAKE2b-256 a049a532fd9b946c51d85855228a2d82b4bf12e915ebc8492d5311116e687811

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