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).

Updates:

3DeeCellTracker v0.4.4 was released with following issues fixed (2022.06.03)

  • Solved an installation bug.

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
  • Update the 3DeeCellTracker package to the latest version
$ pip install --upgrade 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

We have wrote a tutorial explaining how to install and use 3DeeCellTracker. See Bio-protocol, 2022

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.4.tar.gz (36.7 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.4-py3-none-any.whl (36.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: 3DeeCellTracker-0.4.4.tar.gz
  • Upload date:
  • Size: 36.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.11

File hashes

Hashes for 3DeeCellTracker-0.4.4.tar.gz
Algorithm Hash digest
SHA256 e2e3f3ceb9a2821e25090f25ec66588df8bb70f1dc3e66ece2c1575a035a257e
MD5 3776da5647e7b63aba277cdf3b6419bd
BLAKE2b-256 f4a12f5da2c64d55956082e6054f9941c3f4756ee3f1babd6c253cc4f84d88e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for 3DeeCellTracker-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6ac873c7e44d1e5bef405175994c34cfd7d5ca75d1623952514694f65de9ea9c
MD5 22a3b1e8e6356080f69e495757f2236b
BLAKE2b-256 ecc0788e06b59893bfeceba3241ace2b27c04e1a9bdf8424ac54116ae0f711f6

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