Skip to main content

Segmentation tool for biological cells of irregular size and shape in 3D and 2D.

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-8.0.0.tar.gz (30.0 MB view details)

Uploaded Source

Built Distribution

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

vollseg-8.0.0-py3-none-any.whl (30.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vollseg-8.0.0.tar.gz
  • Upload date:
  • Size: 30.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for vollseg-8.0.0.tar.gz
Algorithm Hash digest
SHA256 6f7c39ca52b8d7e784566b01ce640804b0c127ee0af458345660f4ba50316209
MD5 44c2bba0db01b452a669028ec36643cb
BLAKE2b-256 148b92d2b235d5fdbac8f3204ebb2837fc35d27cf3f0ff4e1889bf1b5a235566

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vollseg-8.0.0-py3-none-any.whl
  • Upload date:
  • Size: 30.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for vollseg-8.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd5e33386c0ca734cbef09cb8799dd68b07ea6782b7ded013ba9d7b5fef40497
MD5 c183d684f86a8b29d8a8280cf75a5e72
BLAKE2b-256 82cb47fbb51ed45ecdf0d82805d5ee07c37dd5ada8c36fb5785b1c35e10b33b5

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