Skip to main content

A package for tracking cells in 3D time lapse images

Project description

3DeeCellTracker

PyPI PyPI - Downloads GitHub

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

Updates:

2021.06.xx

We will update our program to 3DeeCellTracker v0.4.0:

  • The notebooks and the underlying package were largely modified 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:

  • The tracking speed was remarkably increased by using vectorization.

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.

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. The data for demonstration and the previous demo codes can be found in the SSBD database

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 JetBrainsfor for supporting this project with free open source Pycharm license.

Pycharm Logo Pycharm Logo

Project details


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.0.tar.gz (33.9 kB view hashes)

Uploaded Source

Built Distribution

3DeeCellTracker-0.4.0-py3-none-any.whl (34.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page