Skip to content

Cell tracker designed for tracking intestinal organoids

License

Notifications You must be signed in to change notification settings

jvzonlab/OrganoidTracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

bef7167 · Dec 19, 2024
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo OrganoidTracker

Publication of OrganoidTracker 1 / Pre-print of OrganoidTracker 2

Program for tracking cell nuclei in (intestinal) organoids over time. Uses a convolutional neural network for nucleus detection, a min-cost flow solver (Haubold, 2016) for linking nuclei over time and tools for manual error correction.

Features

Screenshot

Screenshot of the program

Intended workflow

  1. Do some manual tracking to obtain ground truth data and training data.
  2. Train the neural networks.
  3. Apply the automated tracker on some new time lapse movie.
  4. Correct the errors in the tracking data of that time lapse movie.
  5. Use the corrected tracking data as additional training data for the neural network.
  6. Want to track another time lapse movie? Go back to step 3.

Tutorial on manual tracking
Tutorial on automated tracking

Installation

OrganoidTracker must be installed using Anaconda. See the installation page for details. If you are updating from an older version of OrganoidTracker, its dependencies might have changed, and in that case you also need to visit the installation page.

Running the main program

Open an Anaconda Prompt, activate the correct environment and navigate to the folder in which you installed OrganoidTracker. The organoid_tracker.py script starts a graphical program that allows you to visualize and edit your data.

Reading the manual

After you have installed the software, please have a look at the manual. The manual is also available from the Help menu in the program; this works even when you're offline.

Pre-trained neural networks

Example data

Example intestinal organoid data is available with associated automated tracking results and can be used to try out the software. We have included the settings and executables used to generate the tracking results.

API

You can also use OrganoidTracker as a library to write your own scripts. All public functions in OrganoidTracker have docstrings to explain what they are doing. As a starting point for using the API, see the API page.

Using a Jupyter Notebook

It's possible to use OrganoidTracker from Jupyter Notebooks. Just install the notebook conda package into your OrganoidTracker environment and everything should be ready. Detailed instructions to get you started are available at the Jupyter manual page.

Editing the source code

Install the program as normal, and then point your Python editor (PyCharm or Visual Studio Code are recommended) to this directory. Make sure to select the organoid_tracker Anaconda environment as the Python environment.

License and reuse

The files dealing with the neural network are licensed under the MIT license. This is indicated at the top of those files. Other files are licensed under the GPL license. Please cite the publication if you're using this work.