Welcome to CellSeg3D!#

_images/plugin_welcome.png

CellSeg3D is a toolbox for 3D segmentation of cells in light-sheet microscopy images, using napari. Use CellSeg3D to:

  • Review labeled cell volumes from whole-brain samples of mice imaged by mesoSPIM microscopy [1]

  • Train and use segmentation models from the MONAI project [2]

  • Train and use our WNet3D unsupervised model

  • Or implement your own custom 3D segmentation models using PyTorch!

CellSeg3D demo

Fig. 1 Demo of the plugin#

Requirements#

Important

This package requires PyQt5 or PySide2 to be installed first for napari to run. If you do not have a Qt backend installed you can use : pip install napari[all] to install PyQt5 by default.

This package depends on PyTorch and certain optional dependencies of MONAI. These come as requirements, but if you need further assistance, please see below.

Note

A CUDA-capable GPU is not needed but very strongly recommended, especially for training and to a lesser degree inference.

  • For help with PyTorch, please see PyTorch’s website for installation instructions, with or without CUDA according to your hardware. Depending on your setup, you might wish to install torch first.

  • If you get errors from MONAI regarding missing readers, please see MONAI’s optional dependencies page for instructions on getting the readers required by your images.

Installation#

CellSeg3D can be run on Windows, Linux, or MacOS.

For detailed installation instructions, including installing pre-requisites, please see Installation guide ⚙

Warning

ARM64 MacOS users, please refer to the dedicated section

You can install napari-cellseg3d via pip:

pip install napari-cellseg3d

For local installation after cloning from GitHub, please run the following in the CellSeg3D folder:

pip install -e .

If the installation was successful, you will find the napari-cellseg3D plugin in the Plugins section of napari.

Usage#

To use the plugin, please run:

napari

Then go into Plugins > CellSeg3D

_images/plugin_menu.png

and choose the correct tool to use:

  • Labeling🔍: Examine and refine your labels, whether manually annotated or predicted by a pre-trained model.

  • Training📉: Train segmentation algorithms on your own data.

  • Inference📊: Use pre-trained segmentation algorithms on volumes to automate cell labelling.

  • Utilities 🛠: Leverage various utilities, including cropping your volumes and labels, converting semantic to instance labels, and more.

  • Help/About… : Quick access to version info, Github pages and documentation.

Hint

Many buttons have tooltips to help you understand what they do. Simply hover over them to see the tooltip.

Documentation contents#

From this page you can access the guides on the several modules available for your tasks, such as :

Other useful napari plugins#

Important

Please note that these plugins are not developed by us, and we cannot guarantee their compatibility, functionality or support.
Installing napari plugins in separated environments is recommended.

Acknowledgments & References#

If you find our code or ideas useful, please cite:

Achard Cyril, Kousi Timokleia, Frey Markus, Vidal Maxime, Paychère Yves, Hofmann Colin, Iqbal Asim, Hausmann Sebastien B, Pagès Stéphane, Mathis Mackenzie Weygandt (2024) CellSeg3D: self-supervised 3D cell segmentation for microscopy eLife https://doi.org/10.7554/eLife.99848.1

This plugin additionally uses the following libraries and software:

References