Skip to main content

A plugin to automatically count lung organoids using Deep Learning.

Project description

Napari Organoid Counter - Version 0.2 is out!

napari hub stability-stable DOI License PyPI Python Version tests codecov

A napari plugin to automatically count lung organoids from microscopy imaging data. Note: this plugin only supports single channel grayscale images.

Hold it for the demo!

Alt Text


This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.

Installation

This plugin has been tested with python 3.9 and 3.10 - you may consider using conda to create your dedicated environment before running the napari-organoid-counter.

  1. You can install napari-organoid-counter via pip:

    pip install napari-organoid-counter

    To install latest development version :

    pip install git+https://github.com/HelmholtzAI-Consultants-Munich/napari-organoid-counter.git

  2. Additionally, you will then need to install one additional dependency:

    mim install "mmcv<2.2.0,>=2.0.0rc4"

For installing on a Windows machine directly from within napari, follow the instuctions here. Step 2 additionally needs to be performed here too (mim install "mmcv<2.2.0,>=2.0.0rc4").

What's new in v2?

Checkout our What's New in v2 here.

How to use?

After installing, you can start napari (either by typing napari in your terminal or by launching the application) and select the plugin from the drop down menu.

For more information on this plugin, its' intended audience, as well as Quickstart guide go to our Quickstart guide.

Contributing

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

License

Distributed under the terms of the MIT license, "napari-organoid-counter" is free and open source software

Dependencies

napari-organoid-counter uses the napari-aicsimageio[1] [2] plugin for reading and processing CZI images.

[1] Eva Maxfield Brown, Dan Toloudis, Jamie Sherman, Madison Swain-Bowden, Talley Lambert, AICSImageIO Contributors (2021). AICSImageIO: Image Reading, Metadata Conversion, and Image Writing for Microscopy Images in Pure Python [Computer software]. GitHub. https://github.com/AllenCellModeling/aicsimageio

[2] Eva Maxfield Brown, Talley Lambert, Peter Sobolewski, Napari-AICSImageIO Contributors (2021). Napari-AICSImageIO: Image Reading in Napari using AICSImageIO [Computer software]. GitHub. https://github.com/AllenCellModeling/napari-aicsimageio

The latest version also uses models developed with the mmdetection package [3], see here

[3] Chen, Kai, et al. "MMDetection: Open mmlab detection toolbox and benchmark." arXiv preprint arXiv:1906.07155 (2019).

Issues

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

Citing

If you use this plugin for your work, please cite it using the following:

Christina Bukas, Harshavardhan Subramanian, & Marie Piraud. (2023). HelmholtzAI-Consultants-Munich/napari-organoid-counter: v0.2.0 (v0.2.0). Zenodo. https://doi.org/10.5281/zenodo.7859571

bibtex:

@software{christina_bukas_2022_6457904,
  author       = {Christina Bukas, Harshavardhan Subramanian, & Marie Piraud},
  title        = {{HelmholtzAI-Consultants-Munich/napari-organoid- 
                   counter: second release of the napari plugin for lung
                   organoid counting}},
  month        = apr,
  year         = 2023,
  publisher    = {Zenodo},
  version      = {v0.2.0},
  doi          = {10.5281/zenodo.7859571},
  url          = {https://doi.org/10.5281/zenodo.7859571}
}

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

napari_organoid_counter-0.2.5.tar.gz (69.6 MB view details)

Uploaded Source

Built Distribution

napari_organoid_counter-0.2.5-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file napari_organoid_counter-0.2.5.tar.gz.

File metadata

File hashes

Hashes for napari_organoid_counter-0.2.5.tar.gz
Algorithm Hash digest
SHA256 968a51ca1d9968949cc6e071d0bf3a10a15969250873774924dd86424f6986ea
MD5 9dd44b6586911d44ea4ac06342e793cd
BLAKE2b-256 b4a7eebf3e1b8aa7b26e5a71f8eeb81aa5c3c575ee34978a95ff617732a55692

See more details on using hashes here.

File details

Details for the file napari_organoid_counter-0.2.5-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_organoid_counter-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1e0bc3cacd8bbdb57767e9882aaacfd92ca5594546a11a7707aa52bb41a3f7c4
MD5 40b9a3fb3a282c381613a4deb4351d36
BLAKE2b-256 d435ed211563d41e71b29f19a224ef35a21887e6823389dc4ce9c49065325731

See more details on using hashes here.

Supported by

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