Skip to main content

Merge Stardist Masks

Project description

PyPI Zenodo Status Python Version License

Read the documentation at https://merge-stardist-masks.readthedocs.io/ Tests Codecov

pre-commit Black

This repository contains the python package for the new StarDist post-processing step StarDist OPP. StarDist OPP allows to use StarDist segmentation on non-star-convex objects. In our paper, we show that StarDist OPP outperforms other methods in instance segmentation tasks for three-dimensional microbial biofilms. Check it out for more information.

https://github.com/gatoniel/merge-stardist-masks/raw/main/images/graphical-overview.png

Features

  • StarDist OPP merges masks together - hence the repository name

https://github.com/gatoniel/merge-stardist-masks/raw/main/images/graphical-algorithm-explanation.png
  • StarDist OPP works in 2D and 3D

  • In 2D, StarDist OPP works also on big and winding objects

Requirements

Usage

Please see the EXAMPLE in Usage for details or check out the tutorial of our napari plugin to directly use StarDist OPP on your data.

Installation

You can install StarDist OPP via pip from PyPI:

$ pip install merge-stardist-masks

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, StarDist OPP is free and open source software.

Issues

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

How to cite

@article{https://doi.org/10.1111/mmi.15064,
author = {Jelli, Eric and Ohmura, Takuya and Netter, Niklas and Abt, Martin and Jiménez-Siebert, Eva and Neuhaus, Konstantin and Rode, Daniel K. H. and Nadell, Carey D. and Drescher, Knut},
title = {Single-cell segmentation in bacterial biofilms with an optimized deep learning method enables tracking of cell lineages and measurements of growth rates},
journal = {Molecular Microbiology},
volume = {119},
number = {6},
pages = {659-676},
keywords = {3D segmentation, biofilm, deep learning, image analysis, image cytometry, Vibrio cholerae},
doi = {https://doi.org/10.1111/mmi.15064},
url = {https://onlinelibrary.wiley.com/doi/abs/10.1111/mmi.15064},
eprint = {https://onlinelibrary.wiley.com/doi/pdf/10.1111/mmi.15064},
abstract = {Abstract Bacteria often grow into matrix-encased three-dimensional (3D) biofilm communities, which can be imaged at cellular resolution using confocal microscopy. From these 3D images, measurements of single-cell properties with high spatiotemporal resolution are required to investigate cellular heterogeneity and dynamical processes inside biofilms. However, the required measurements rely on the automated segmentation of bacterial cells in 3D images, which is a technical challenge. To improve the accuracy of single-cell segmentation in 3D biofilms, we first evaluated recent classical and deep learning segmentation algorithms. We then extended StarDist, a state-of-the-art deep learning algorithm, by optimizing the post-processing for bacteria, which resulted in the most accurate segmentation results for biofilms among all investigated algorithms. To generate the large 3D training dataset required for deep learning, we developed an iterative process of automated segmentation followed by semi-manual correction, resulting in >18,000 annotated Vibrio cholerae cells in 3D images. We demonstrate that this large training dataset and the neural network with optimized post-processing yield accurate segmentation results for biofilms of different species and on biofilm images from different microscopes. Finally, we used the accurate single-cell segmentation results to track cell lineages in biofilms and to perform spatiotemporal measurements of single-cell growth rates during biofilm development.},
year = {2023}
}
https://github.com/gatoniel/merge-stardist-masks/raw/main/images/stardist-opp-cover-image.png

Credits

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.

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

merge_stardist_masks-0.2.1.tar.gz (26.8 kB view details)

Uploaded Source

Built Distribution

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

merge_stardist_masks-0.2.1-py3-none-any.whl (32.9 kB view details)

Uploaded Python 3

File details

Details for the file merge_stardist_masks-0.2.1.tar.gz.

File metadata

  • Download URL: merge_stardist_masks-0.2.1.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for merge_stardist_masks-0.2.1.tar.gz
Algorithm Hash digest
SHA256 871b842b3c99ffe35626fad7a83b7edf1c2dce147e1a27069c3f47b6aa474f51
MD5 1bdf4e9b526bf87c0d9b43fa59cef54e
BLAKE2b-256 32cbb852fab32ec45c83dad14609bc05e15f10b37ba8c665ee9d5b981c1b49fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for merge_stardist_masks-0.2.1.tar.gz:

Publisher: release.yml on gatoniel/merge-stardist-masks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file merge_stardist_masks-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for merge_stardist_masks-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a723fa6c2ede8b88205b33d2fd661c6e19c2757bb7cb9f560f4fb33590e7e7ed
MD5 10511bae716372a8372bd6334fc1a764
BLAKE2b-256 09fadd62147c6f484810ef83c360fce5ef9fd28d05db38cb860ae7b0313d111c

See more details on using hashes here.

Provenance

The following attestation bundles were made for merge_stardist_masks-0.2.1-py3-none-any.whl:

Publisher: release.yml on gatoniel/merge-stardist-masks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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