napari Sediment

napari-sediment

A plugin to process hyperspectral images of sediments

License BSD-3 PyPI Python Version tests codecov napari hub

This napari plugin is designed to hpyerspectral images of sediment cores. It is composed of three interfaces allowing the user to:

  • import HDR images
  • normalize the images using white and dark references
  • mask unwanted regions
  • perform spectral dimensionality reduction via minimum noise fraction analysis
  • perform spatial dimensionality reduction based on pixel purity indices
  • identify representative end-members by clustering pure pixels
  • select relevant regions in spectra to compute absorption indices and create absorption maps

Pre-processing: Sediment widget

The sediment widget allows the user to import an HDR image and to normalize it using white and dark references. The widget also allows the user to mask unwanted regions of the images.

Documentation

You can find a detailed documentation here.

Installation

Create a conda environment and activate it. We highly recommend to use the new conda version called mamba to speed up the installation process. You can install it from here. If you don't use mamba, replace the mamba command by conda in the following instructions:

mamba create -n sediment python=3.9 napari pyqt -c conda-forge
mamba activate sediment

Then you can install napari-sediment use:

pip install git+https://github.com/guiwitz/napari-sediment.git

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, "napari-sediment" is free and open source software

Authors

This plugin has been developed by Guillaume Witz at the Data Science Lab of the University of Bern in collaboration with Petra Zahajská, Institue of Geography of the University of Bern. Funding for development was provided by Prof. Martin Grosjean, Institute of Geography of the University of Bern.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Version:

  • 0.2.2

Last updated:

  • 14 October 2024

First released:

  • 23 September 2024

License:

Supported data:

  • Information not submitted

Plugin type:

Open extension:

GitHub activity:

  • Stars: 0
  • Forks: 1
  • Issues + PRs: 34

Python versions supported:

Operating system:

Requirements:

  • numpy<2
  • zarr
  • magicgui
  • qtpy
  • napari-guitils
  • napari-convpaint
  • superqt
  • natsort
  • spectral
  • matplotlib
  • scikit-image
  • scikit-learn
  • PyYAML
  • microfilm
  • dask
  • distributed
  • tqdm
  • cmap
  • colour-science