Skip to main content

napari-findaureus

napari-findaureus is a napari plugin that locates Staphylococcus aureus (bacteria) in fluorescence-labelled infected bone tissue images acquired with confocal laser scanning microscopy (CLSM).

Compatibility: Python 3.9–3.11 and recent napari releases. The package aims to work with modern napari/Qt stacks; if you encounter compatibility issues, consider creating a fresh environment with a supported Python version.

Findaureus is a tool designed to identify bacteria in infected bone tissue images obtained via Confocal Laser Scanning Microscopy (CLSM). This tool can be accessed independently here. Findaureus has been integrated as a plugin for napari. In addition to its bacteria-locating algorithm, the napari viewer provides enhanced 2D and 3D visualization, region-of-interest-based bacteria finding with relevant stats in the widget, and an Export results button to save analysis summaries.


Installation

Recommended: create a fresh conda environment using Python 3.11 and install napari in that environment.

Linux / Windows:

conda create -n napari-findaureus python=3.11
conda activate napari-findaureus
pip install "napari[all]" napari-findaureus

macOS:

conda create -n napari-findaureus python=3.11
conda activate napari-findaureus
conda install -c conda-forge pyqt
pip install "napari[all]" napari-findaureus

If you do not already have a suitable test image, download sample data from Zenodo

Using napari-findaureus

  1. Launch napari from the activated environment:
napari
  1. Open your image in napari using File > Open or by drag-and-drop.

    • If you do not have an image, download it from Zenodo and open it in napari.
  2. Open Plugins > napari-findaureus to display the plugin widget.

  3. From the napari layer list panel select the correct bacteria channel or layer for analysis.

  4. Optional ROI analysis:

    • Draw a region of interest using the Shapes layer.
    • The analysis will be restricted to the selected ROI when a shape is active.
  5. Click Find bacteria! to run the detection.

  6. Review the results:

    • Bacteria mask layer for pixel-wise segmentation
    • Bounding box layer for detected objects
    • Counts and area measurements per Z-plane and for the selected ROI or full image
    • Use the Export results button (below the Analysis Results box) to save a compact TXT or CSV containing image info and per‑Z‑plane bacteria counts and areas.
  7. Use Reset to clear results before analyzing another image or ROI.

  8. Use the Instruction button in the widget for built-in guidance.


Contributing

We welcome and appreciate all contributions to the napari-findaureus project! Whether it's reporting bugs, suggesting new features, improving documentation, or writing code, your involvement is greatly valued. When using our dataset or referring to our work, we kindly ask that you acknowledge the dataset and cite the related articles. This helps support our work and allows us to continue improving this project.

Thank you for your interest and support!

Citations and Dataset

Findaureus

Mandal S, Tannert A, Löffler B, Neugebauer U, Silva LB (2024) Findaureus: An open-source application for locating Staphylococcus aureus in fluorescence-labelled infected bone tissue slices. PLoS ONE 19(1): e0296854.

Infected mouse bone tissue

Mandal S, Tannert A, Ebert C, Guliev RR, Ozegowski Y, Carvalho L, Wildemann B, Eiserloh S, Coldewey SM, Löffler B, Bastião Silva L, Hoerr V, Tuchscherr L, Neugebauer U. (2023) Insights into S. aureus-Induced Bone Deformation in a Mouse Model of Chronic Osteomyelitis Using Fluorescence and Raman Imaging. International Journal of Molecular Sciences 24(11):9762.

Dataset

Acknowledgements

This project is a part of the European Union's Horizon 2020 research and innovation program under grant agreement No 861122 (ITN IMAGE-IN). We acknowledge support from the Jena Biophotonics and Imaging Laboratory (JBIL), from the European Union via EFRE funds within the Thüringer Innovationszentrum für Medizintechnik-Lösungen (ThIMEDOP, FKZ IZN 2018 0002), the BMBF via the funding program Photonics Research Germany (LPI, FKZ: 13N15713) and via the CSCC (FKZ 01EO1502) and the Institute of Anatomical and Molecular Pathology, University Coimbra, Portugal.

Release files for napari-findaureus 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for napari-findaureus 1.0.0
File Size Uploaded
napari_findaureus-1.0.0.tar.gz 98.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for napari-findaureus 1.0.0
File Interpreter ABI Platform
napari_findaureus-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 195.5 kB

Release files / napari_findaureus-1.0.0.tar.gz

Download URL napari_findaureus-1.0.0.tar.gz
Size 98.4 kB
Tags Source
SHA-256 checksum
How to use checksums
8a105037f33cca4d17ed36c6bdacfcd2dacca10803c6fb9a995a31914fd552fb
BLAKE2b-256 checksum
How to use checksums
3704463c4edeb445db4e21599d7ba6eb7b14fdc0826156b04175f72606f73d5a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.5

Release files / napari_findaureus-1.0.0-py3-none-any.whl

Download URL napari_findaureus-1.0.0-py3-none-any.whl
Size 97.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e1c1d07b38a9b0cdc360e11de06e9a47c47c21851296d55ea2b25a9bbed63a95
BLAKE2b-256 checksum
How to use checksums
661b102104d51b9199ce617c99bc6bfd38c56f0139961e9c5478e4627b782241
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.5

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page