deeptrack 0.7.0

A deep learning oriented microscopy image simulation package

DeepTrack is a comprehensive deep learning framework for digital microscopy. We provide tools to create physical simulations of customizable optical systems, to generate and train neural network models, and to analyze experimental data.

Getting started

Installation

DeepTrack 2.0 requires at least python 3.6

To install DeepTrack 2.0, open a terminal or command prompt and run

pip install deeptrack

Learning DeepTrack 2.0

Everybody learns in different ways! Depending on your preferences, and what you want to do with DeepTrack, you may want to check out one or more of these resources.

Fundamentals

First, we have a very general walkthrough of basic and advanced topics. This is a 5-10 minute read, that well get you well on your way to understand the unique interactions available in DeepTrack.

DeepTrack 2.0 in action

To see DeepTrack in action, we provide six well documented tutorial notebooks that create simulation pipelines and train models:

1. deeptrack_introduction_tutorial gives an overview of how to use DeepTrack 2.0.
2. tracking_particle_cnn_tutorial demonstrates how to track a point particle with a convolutional neural network (CNN).
3. tracking_multiple_particles_unet_tutorial demonstrates how to track multiple particles using a U-net.
4. characterizing_aberrations_tutorial demonstrates how to add and characterize aberrations of an optical device.
5. distinguishing_particles_in_brightfield_tutorial demonstrates how to use a U-net to track and distinguish particles of different sizes in brightfield microscopy.
6. analyzing_video_tutorial demonstrates how to create videos and how to train a neural network to analyze them.

Additionally, we have seven more case studies which are less documented, but gives additional insight in how to use DeepTrack with real datasets

1. MNIST classifies handwritted digits.
2. single particle tracking tracks experimentally captured videos of a single particle. (Requires opencv-python compiled with ffmpeg to open and read a video.)
3. single particle sizing extracts the radius and refractive index of particles.
4. multi-particle tracking detects quantum dots in a low SNR image.
5. 3-dimensional tracking tracks particles in three dimensions.
6. cell counting counts the number of cells in fluorescence images.
7. GAN image generation uses a GAN to create cell image from masks.

Video Tutorials

[TBA]

In-depth dives

The examples folder contains notebooks which explains the different modules in more detail. These can be read in any order, but we provide a recommended order where more fundamental topics are introduced early. This order is as follows:

1. features_example
2. properties_example
3. scatterers_example
4. optics_example
5. aberrations_example
6. noises_example
7. augmentations_example
8. image_example
9. generators_example
10. models_example
11. losses_example
12. utils_example
13. sequences_example
14. math_example

Documentation

The detailed documentation of DeepTrack 2.0 is available at the following link: https://softmatterlab.github.io/DeepTrack-2.0/deeptrack.html

Funding

This work was supported by the ERC Starting Grant ComplexSwimmers (Grant No. 677511).