Skip to main content

Segmentation tool for biological cells of irregular size and shape in 3D and 2D, using StarDist, U-NET, CARE, CellPose and SAM

Project description

VollSeg

Build Status PyPI version License Twitter Badge

3D segmentation tool for irregular shaped cells Segmentation

Installation

This package can be installed by

pip install --user vollseg

mamba install pytorch torchvision torchaudio pytorch-cuda=11.6 -c pytorch -c nvidia

If you are building this from the source, clone the repository and install via

git clone https://github.com/kapoorlab/vollseg/

cd vollseg

pip install --user -e .

`mamba install pytorch torchvision torchaudio pytorch-cuda=11.6 -c pytorch -c nvidia`

Pipenv install

Pipenv allows you to install dependencies in a virtual environment.

# install pipenv if you don't already have it installed
pip install --user pipenv

# clone the repository and sync the dependencies
git clone https://github.com/kapoorlab/vollseg/
cd vollseg
pipenv sync

# make the current package available
pipenv run python setup.py develop
`mamba install pytorch torchvision torchaudio pytorch-cuda=11.6 -c pytorch -c nvidia`
# you can run the example notebooks by starting the jupyter notebook inside the virtual env
pipenv run jupyter notebook

Access the example folder and run the cells.

Algorithm

Algorithm

Schematic representation showing the segmentation approach used in VollSeg. First, we input the raw fluorescent image in 3D (A) and preprocess it to remove noise. Next, we obtain the star convex approximation to the cells using Stardist (B) and the U-Net prediction labelled via connected components (C). We then obtain seeds from the centroids of labelled image in B, for each labelled region of C in order to create bounding boxes and centroids. If there is no seed from B in the bounding box region from U-Net, we add the new centroid (in yellow) to the seed pool (D). Finally, we do a marker controlled watershed in 3D using skimage implementation on the probability map shown in (E) to obtain final cell segmentation result shown in (F). All images are displayed in Napari viewer with 3D display view.

Example

To try the provided notebooks we provide an example dataset of Arabidopsis, Binary Images, Raw Images and Labelled images and trained models: stardist, Denoising, U-Net. For training the networks use this notebook in Colab. To train a denoising model using noise to void use this notebook

Docker

A Docker image can be used to run the code in a container. Once inside the project's directory, build the image with:

docker build -t voll .

Now to run the track command:

# show help
docker run --rm -it voll

Requirements

  • Python 3.7 and above.

License

Under MIT license. See LICENSE.

Authors

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vollseg-31.1.8.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

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

vollseg-31.1.8-py3-none-any.whl (109.7 kB view details)

Uploaded Python 3

File details

Details for the file vollseg-31.1.8.tar.gz.

File metadata

  • Download URL: vollseg-31.1.8.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/6.6.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.65.0 CPython/3.9.0

File hashes

Hashes for vollseg-31.1.8.tar.gz
Algorithm Hash digest
SHA256 66c789c9c4c578b61680593ef4b7750a27cb404ab2eab50d2cd301776a161b21
MD5 fece6f78f3f7b67696256ff26220d5ea
BLAKE2b-256 a62bb887092819537b30ae9aeb267db5fe273a1fe8286287e9394679f62016be

See more details on using hashes here.

File details

Details for the file vollseg-31.1.8-py3-none-any.whl.

File metadata

  • Download URL: vollseg-31.1.8-py3-none-any.whl
  • Upload date:
  • Size: 109.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/6.6.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.65.0 CPython/3.9.0

File hashes

Hashes for vollseg-31.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 fc0587ab68028ba3a6f1c3a29a417d066c219f21a901271c070c7105d35ceb9b
MD5 ff599af1c863f4b3cb18d1fee2af19ba
BLAKE2b-256 d1ccbfb5181bec453b5cc230fe6feeafb7782346b5d4b4d65935a6415596fed7

See more details on using hashes here.

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