Skip to main content

3DeeCellTracker

PyPI PyPI - Downloads GitHub Youtube

3DeeCellTracker is a deep-learning based pipeline for tracking cells in 3D time lapse images of deforming/moving organs (eLife, 2021).

To do:

In the next version of our PyPI package 3DeeCellTracker v0.4.1, following issues will be fixed:

  • Solve the bug "the directions of arrows showing the accurate correction are opposite"
    • The codes here have been fixed
  • Add functions for extracting/drawing activities from cell images based on tracked labels
  • Add the function for storing coordinates of tracked cells

Other critical issues to be solved:

  • Currently, 3DeeCellTracker only works with TensorFlow-gpu 1.x which does not support some latest NVIDIA GPU models using CUDA 11 drivers. This issue will be sovled in future versions of 3DeeCellTracker.

Updates:

2021.06.17

We have updated our program to 3DeeCellTracker v0.4.0:

  • We modified the notebooks, and the underlying package to simplify the use.
  • The intermediate results of segmentation and tracking can be visualized easily to assist the parameter optimization.

2021.03.29

We have updated our program to 3DeeCellTracker v0.3:

  • By using vectorization, we remarkably reduced the runtime for tracking cells.

Installation

  • Create a conda environment for a PC with GPU including prerequisite packages using the 3DCT.yml file:
$ conda env create -f 3DCT.yml
  • (NOT RECOMMEND) Users can create a conda environment for a PC with only CPU, but it will be slow and may fail.
$ conda env create -f 3DCT-CPU.yml
  • Install the 3DeeCellTracker package solely by pip
$ pip install 3DeeCellTracker

For detailed instructions, see here.

Quick Start

To learn how to track cells use 3DeeCellTracker, see following notebooks for examples:

  1. Track cells in deforming organs:

  2. Track cells in freely moving animals:

  3. Train a new 3D U-Net for segmenting cells in new optical conditions:

The data and model files for demonstrating above notebooks can be downloaded here.

Note: Codes above were based on the latest version. For old programs used in eLife 2021, please check the "Deprecated_programs" folder.

Video Tutorials

We have made tutorials explaining how to use our software. See links below (videos in Youtube):

Tutorial 1: Install 3DeeCellTracker and train the 3D U-Net

Tutorial 2: Tracking cells by 3DeeCellTracker

Tutorial 3: Annotate cells for training 3D U-Net

Tutorial 4: Manually correct the cell segmentation

A Text Tutorial

LINK: https://bio-protocol.org/prep1350

How it works

We designed this pipeline for segmenting and tracking cells in 3D + T images in deforming organs. The methods have been explained in Wen et al. bioRxiv 2018 and in Wen et al. eLife, 2021.

Overall procedures of our method (Wen et al. eLife, 2021–Figure 1)

Examples of tracking results (Wen et al. eLife, 2021–Videos)

Neurons in a ‘straightened’
freely moving worm
Cardiac cells in a zebrafish larva Cells in a 3D tumor spheriod

Citation

If you used this package in your research and is interested in citing it here's how you do it:

@article{
author = {Wen, Chentao and Miura, Takuya and Voleti, Venkatakaushik and Yamaguchi, Kazushi and Tsutsumi, Motosuke and Yamamoto, Kei and Otomo, Kohei and Fujie, Yukako and Teramoto, Takayuki and Ishihara, Takeshi and Aoki, Kazuhiro and Nemoto, Tomomi and Hillman, Elizabeth MC and Kimura, Koutarou D},
doi = {10.7554/eLife.59187},
journal = {eLife},
month = {mar},
title = {{3DeeCellTracker, a deep learning-based pipeline for segmenting and tracking cells in 3D time lapse images}},
volume = {10},
year = {2021}
}

Acknowledgements

We wish to thank JetBrains for supporting this project with free open source Pycharm license.

Pycharm Logo Pycharm Logo

Download files

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

Source Distribution

3DeeCellTracker-0.4.1.tar.gz (36.5 kB view details)

Uploaded Source

Built Distribution

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

3DeeCellTracker-0.4.1-py3-none-any.whl (36.7 kB view details)

Uploaded Python 3

File details

Details for the file 3DeeCellTracker-0.4.1.tar.gz.

File metadata

  • Download URL: 3DeeCellTracker-0.4.1.tar.gz
  • Upload date:
  • Size: 36.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/3.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.3

File hashes

Hashes for 3DeeCellTracker-0.4.1.tar.gz
Algorithm Hash digest
SHA256 746ad9432f641b54c5e13e7ff9c498e50521d86afbd9f2a71808cecebff9ed4c
MD5 81cdafe7fe87d6cb8b59706d9a386e47
BLAKE2b-256 b4760c704e8ee8cc831289a2740f5463786b3f672be0636ad1d06b8dd2a81ac6

See more details on using hashes here.

File details

Details for the file 3DeeCellTracker-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: 3DeeCellTracker-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 36.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/3.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.3

File hashes

Hashes for 3DeeCellTracker-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 292336c8c9b6d4f45abdc8562fc5f8ea5f265b77031544226e6906d2dd1049cf
MD5 99491f765a71e7cf75434fd915f9dd6a
BLAKE2b-256 bf88c3d8ccbc10e20d93b5ecdd78483b1fd2b4b82ea36ec511a1aa8697501020

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