Short Description

This plugin ships automated methods for extracting trajectories of multiples objects in a sequence of 2D or 3D images. Up to version 2 it was known as the ‘Probabilistic particle tracker’ plugin.

A number of precious features for object tracking in microscopy images are embedded: the number of targets can vary through time (objects can appear and disappear), false detection (not originating from a target) are automatically detected and discarded, different target dynamics are available (diffusive, directed movement, or both).
The tracking methods relies on a published method (Chenouard et al., TPAMI, 2013) which is termed ‘multiframe’ in the sense that at a given time point of the image sequence multiple past and futures frames are considered for building the best set of tracks. It is part of the family of ‘probabilistic’ tracking methods in the sense that a statistical model of the particle trajectories and acquisition device is built such as tracking decisions are optimal according to a given statistical criterion with respect to this model. By default, a rough estimation of the parameters of the statistical model will be evaluated by the software such that virtually no parameter tuning is required from the user. However, for optimal control of the methods, a dedicated interface can give access to the full set of parameters.
The tracking methods are freely provided for use and modification. By using the provided methods you agree to properly reference the scientific work at their roots in any written or oral communication exposing a work that took advantage of them. The exact reference is: Nicolas Chenouard, Isabelle Bloch, Jean-Christophe Olivo-Marin, “Multiple Hypothesis Tracking for Cluttered Biological Image Sequences,” IEEE Transactions on Pattern Analysis and Machine Intelligence, vol. 35, no. 11, pp. 2736-3750, Nov., 2013
Pubmed link: http://www.ncbi.nlm.nih.gov/pubmed/23689865

Documentation

Summary

This plugin ships automated methods for extracting trajectories of multiples objects in a sequence of 2D or 3D images.

A number of precious features for object tracking in microscopy images are embedded: the number of targets can vary through time (objects can appear and disappear), false detection (not originating from a target) are automatically detected and discarded, different target dynamics are available (diffusive, directed movement, or both).

The tracking methods relies on a published method (Multiple Hypothesis Tracking algorithm, aka MHT, described in Chenouard et al., TPAMI, 2013) which is termed ‘multiframe’ in the sense that at a given time point of the image sequence multiple past and futures frames are considered for building the best set of tracks. It is part of the family of ‘probabilistic’ tracking methods in the sense that a statistical model of the particle trajectories and acquisition device is built such as tracking decisions are optimal according to a given statistical criterion with respect to this model. By default, a rough estimation of the parameters of the statistical model will be evaluated by the software such that virtually no parameter tuning is required from the user. However, for optimal control of the methods, a dedicated interface can give access to the full set of parameters.

The tracking methods are freely provided for use and modification. By using the provided methods you agree to properly reference the scientific work at their roots in any written or oral communication exposing a work that took advantage of them. The exact reference is:

Nicolas Chenouard, Isabelle Bloch, Jean-Christophe Olivo-Marin, “Multiple Hypothesis Tracking for Cluttered Biological Image Sequences,” IEEE Transactions on Pattern Analysis and Machine Intelligence, vol. 35, no. 11, pp. 2736-3750, Nov., 2013

Pubmed link: https://pubmed.ncbi.nlm.nih.gov/24051732/

Important Note:
The tracking algorithm that was used up to version 2.0 of the plugin is still accessible from the interface of the plugin by selecting Interface/Legacy Plugin in the menu of the plugin.

Manual Content

  1. Hands-On Manual
  2. Detailed description
  3. Developers note
  4. Reference

I. Hands-On Manual

In general, particle tracking analysis consists in 3 steps:

  1. Identification of particle locations in a time-lapse sequence. We call this step particle detection.
  2. Grouping detected positions through time to estimate spatio-temporal trajectories. This is the so-called particle tracking step.
  3. In the track analysis step, mathematical and statistical tools are used to extract relevant information from the tracks.

The Spot Tracking plugin is focused on the second step, the particle tracking task, but gives easy-access to features of ICY that allows one to perform the whole particle tracking analysis in a both efficient and accurate manner. By default, the plugin interface consists in a simple series of sections, from top to bottom, each of which allows the user to specify relevant parameters and to seamlessly make the link with particle detection and track analysis tools.

1. Particle detection

The user is first asked to specify a set of detections for the objects to track through time. To do so, detection results have to be present in the ‘swimming pool’ of ICY (an odd term designating a shared memory space between plugins). If none exist, please create one using a specialized plugin. The Spot Tracking plugin gives direct access to the Spot Detector plugin that can be used for this purpose. Just click the button ‘Run the Spot Detector plugin’ to launch it. When using this plugin don’t forget to check the option ‘Export to Swimming Pool’ on the ‘Output tab’ so that the Spot Tracking plugin can access its results.

Once detection results are present in the swimming pool, just select them in the box of the first section of the plugin. This will enable the second section if a proper set of detections is selected.

 2. Particle tracking parameters

The tracking algorithms is using a complex statistical model to estimate the best trajectories from the set of particle detections. Specifying a number of parameters is thus required before extracting trajectories. Thankfully, the plugin ships a number of features that should make this step painless, even for non-expert users. One can either automatically (roughly) estimate the parameters of the model or load a predefined set of parameters used for a previous experiment.

For automatic parameter estimation, click the button ‘Estimate parameters’ and follow the directions. Please note that the estimation procedure gives only approximate parameter values that are probably sub-optimal, even though we observed satisfying results in many cases. If necessary, one can access the full set of parameters by switching to the advanced interface
(menu Interface/Advanced Interface).

Click ‘Load existing parameters‘ to import a set of existing parameters. This set of parameters needs to be stored in an XML file exported with the Spot Tracking plugin (via the menu ‘File/Save Parameters’).

3. Tracks Export for post analysis

Extracted trajectories will be automatically exported to the Track Manager plugin so that they can be visualized and various analyses and post-processes can be applied. Saving tracking results in XML files for later analysis is also performed through the menu of the Track Manager plugin.

In the third section of the plugin interface, one is asked to give a unique name for the results of each run of the plugin so that each set of results can be distinguished from one another in the Track Manager interface. Please specify in the text field a name for the result different from those already existing in the ‘swimming pool’.

Once a proper name is given, the fourth section will be made available.

4. Trajectory Extraction

Finally, one can proceed with the track extraction process per se by hitting the ‘Run tracking‘ button. Note that the process can be stopped at any time by pressing the button again.

Once tracking over the whole track sequence is completed the Track Manager plugin will be automatically launched in order to proceed with track analysis, visualization, and export

5. Troubleshoot

Spot Tracking plugin uses the LPSolve C library (see below), still in some rare cases the C library may crash (and so entirely crashed Icy which exit without any warning). In this case you can disable it from Plugin configuration menu and use the pure java solver (slower but safe) :

II. Detailed description

Soon to come!

Meanwhile you can refer to:

Nicolas Chenouard, Isabelle Bloch, Jean-Christophe Olivo-Marin, “Multiple Hypothesis Tracking for Cluttered Biological Image Sequences,” IEEE Transactions on Pattern Analysis and Machine Intelligence, vol. 35, no. 11, pp. 2736-3750, Nov., 2013

for a description of the algorithm that is implemented by the plugin for track extraction. I will try soon to give a complete description here. Meanwhile, please be patient, or contact me by e-mail.

To access the whole set of parameters and options described in this publication, switch to the advanced interface using the menu: ‘Interface/Advanced Interface‘. This interface must be used to set up optimal parameters, in particular for scientific comparison between the provided algorithms and other methods since using the simplified interface yields sub-optimal results due to rough parameters estimation.

III. Developers note

The plugin is provided under licence GPLv3.0, with all sources included.

To access source files, download the plugin with the regular installer through ICY interface. Then, access the folder ‘plugins/nchenouard/particleTracking’ in the home folder of ICY. This one should contain the .jar file of the plugin. Unzip the jar file to gain access to the .java sources and .class files.

I am sorry to say that right now the documentation is pretty scarce and that a javadoc is not yet available. Please be patient, or contact by e-mail for any help with software development.

The plugin is free for any use and modifications. Please make sure that the original author and software are acknowledged if modifications are performed and that the reference [Chenouard et al., TPAMI, 2013] is cited in scientific communications making use of this work.

For the Linear Programming optization step of the MHT the default optimizer is provided by the library LPSolve 5.5 (lpsolve.sourceforge.net/5.5/‎). If the library cannot be loaded, a suboptimal implentation using the optimizer which can be found here: algs4.cs.princeton.edu/65reductions/Simplex.java.html is used. I am grateful to the authors of those library for publishing them.

IV. References

Nicolas Chenouard, Isabelle Bloch, Jean-Christophe Olivo-Marin, “Multiple Hypothesis Tracking for Cluttered Biological Image Sequences,” IEEE Transactions on Pattern Analysis and Machine Intelligence, vol. 35, no. 11, pp. 2736-3750, Nov., 2013

Pubmed link: https://pubmed.ncbi.nlm.nih.gov/24051732/

Resources needing this

6 reviews on “Spot Tracking

  1. Sorin Pop
    Hi Nicolas Can I use your tracking model inside one of my plugins? Do you have a public method to call? Thank you, Sorin
  2. Fabrice de Chaumont
    This new version provides much better results than the previous one, even without giving any parameters ! 2 clicks: tracking done. Very good !
  3. Thibault Lagache
    The best tracking plugin and related algorithm I have used so far. Rapid and efficient on very noisy and dense images. Congrats!
  4. E
    Almost easy to use !!! Great output options improvement.
  5. a
    Emory University
    HI an Awesome program for tracking, compliments and thank you! I have 2 question, 1. after spot detection can I select only 1 or 2 spots (among 100s) and perform tracking only on these 2. also can I get 2 or 3 color intensity profiles in each track. These features would make ICY a superhit in our lab, do let us know of a solution. Thanks. A
  6. Y
    Almost one and half hours used for 320 frames. Is that normal? The images is of 500*500 pixels

Leave a Review

Leave a review
Cancel review
View full changelog
Close changelog

Changelog

  • Version 3.5.5.0 • Released on: 2023-10-17 15:00:00
    Download
    Description:

    Fixed some wrong save & load XML parameters.
    Fixed an error that prevents the plugin to use directed motion instead of diffusion.

  • Version 3.5.4.0 • Released on: 2023-03-03 13:00:00
    Download
    Description:

    Prevent plugin crash during library loading.

  • Version 3.5.3.0 • Released on: 2023-03-02 12:00:00
    Download
    Description:

    Add console logs for headless mode.

  • Version 3.5.2.0 • Released on: 2021-11-15 16:30:00
    Download
    Description:

    Fixed LpSolve library loading with Java 12 or above.

  • Version 3.5.1.0 • Released on: 2021-09-22 18:00:00
    Download
    Description:

    By default we now use the java optimizer as the C library is crashing when a track doesn't contains any virtual detection.

  • Version 3.5.0.0 • Released on: 2021-06-23 11:00:00
    Download
    Description:

    - fixed tracking execution when native LpSolve library couldn't be loaded
    - fixed incomplete detection spot info in some situation

  • Version 3.4.4.0 • Released on: 2019-05-21 10:00:00
    Download
    Description:

    fixed a bug so we can now disable C solver library (which sometime crash) from the plugin preference (setting was there but wasn't used internally) (Stephane)

  • Version 3.4.3.0 • Released on: 2018-09-14 19:55:20
    Download
    Description:

    some cleanup (removed duplicated code)

  • Version 3.4.2.0 • Released on: 2018-09-14 18:40:17
    Download
    Description:

    Fixed several bugs with parameters update.

  • Version 3.4.1.0 • Released on: 2016-11-24 15:24:07
    Download
    Description:

    Minor fix to fix TrackMate import feature.

  • Version 3.4.0.0 • Released on: 2016-11-21 14:39:33
    Download
    Description:

    Added new SpotTracking class with static methods for easier support with Protocol and script (Stephane Dallongeville)

  • Version 3.3.2.0 • Released on: 2016-08-18 18:46:04
    Download
    Description:

    Fixed lpsolve native library loading on OSX with java 8 (compliance patch by Stephane.D - admin action)

  • Version 3.3.1.1 • Released on: 2016-08-18 15:42:37
    Download
    Description:

    reverted.

  • Version 3.3.1.0 • Released on: 2016-08-18 15:30:58
    Download
    Description:

    Fixed case on package name.

  • Version 3.3.0.6 • Released on: 2016-08-18 14:10:35
    Download
    Description:

    Fixed lpsolve native library loading on OSX with java 8 (compliance patch by Stephane.D - admin action)

  • Version 3.3.0.5 • Released on: 2015-10-28 20:40:47
    Download
  • Version 3.3.0.4 • Released on: 2015-10-28 18:42:19
    Download
    Description:

    added public access to parameter estimation

  • Version 3.3.0.3 • Released on: 2015-07-17 19:16:22
    Download
    Description:

    Public access to some methods.

  • Version 3.3.0.2 • Released on: 2014-10-03 22:57:45
    Download
    Description:

    Fixed small bug in 3D tracker initialization.

  • Version 3.3.0.1 • Released on: 2014-09-14 01:47:51
    Download
    Description:

    Ability to disable multithreading and lpsolve via the gui.

  • Version 3.3.0.0 • Released on: 2014-09-13 00:05:08
    Download
    Description:

    Multithreaded computation.

  • Version 3.2.0.1 • Released on: 2014-09-09 18:32:44
    Download
    Description:

    Bug fix: track length parameter is better accounted for.

  • Version 3.2.0.0 • Released on: 2014-09-09 01:37:08
    Download
    Description:

    Feature:
    can run without lpSolve library using a custom linear programming plugin, but is slower.

    Bug fixes:
    - tracking configuration from advanced panel saved to xml files
    - account for more terminated tracks

  • Version 3.1.0.7 • Released on: 2014-04-18 05:31:17
    Download
    Description:

    Allows loading tracks from trackmanager.

  • Version 3.1.0.6 • Released on: 2013-11-20 06:27:17
    Download
    Description:

    Detections in tracks keep the spot (pixel mask) information, which is useful for the TrackProcessorIntensityProfile processor.

  • Version 3.1.0.5 • Released on: 2013-11-19 05:51:35
    Download
    Description:

    Fixed mac os architecture issue

  • Version 3.1.0.4 • Released on: 2013-11-18 20:10:48
    Download
    Description:

    Added 'about' and ' manual' information.

    Fixed some class path name issues.

  • Version 3.1.0.3 • Released on: 2013-11-13 22:24:46
    Download
  • Version 3.1.0.2 • Released on: 2013-11-13 22:17:29
    Download
  • Version 3.1.0.1 • Released on: 2013-11-13 22:12:37
    Download
  • Version 3.1.0.0 • Released on: 2013-11-13 21:58:28
    Download
    Description:

    Major changes at all levels of the plugin: new interface and new tracking algorithm.

    See documentation for a complete description.

    Note that the algorithm from previous version (2.1.0.4) is still accessible through the gui by selecting the 'legacy tracker interface'

  • Version 2.1.0.4 • Released on: 2013-10-11 21:44:45
    Download
  • Version 2.1.0.3 • Released on: 2013-10-11 21:08:23
    Download
    Description:

    IMM 3D bugfix.

  • Version 2.1.0.2 • Released on: 2013-10-11 17:58:02
    Download
    Description:

    Bug fix for multiple dynamic models (IMM) in 3D.

  • Version 2.1.0.1 • Released on: 2013-10-11 00:23:12
    Download
    Description:

    Bugfix for multiple motion models.

    If the spot detector plugin is used for detection, the detection mask is included in the track.

  • Version 2.1.0.0 • Released on: 2012-11-28 22:09:03
    Download
    Description:

    Allows the user to choose between two types of IMM filer: Brownian - Brownian, and Brownian - Directed.

  • Version 2.0.0.2 • Released on: 2012-10-31 17:41:21
    Download
    Description:

    Fixed wrong jdk version.

  • Version 2.0.0.1 • Released on: 2012-10-29 23:37:54
    Download
    Description:

    corrected class names

  • Version 2.0.0.0 • Released on: 2012-10-29 23:31:47
    Download
    Description:

    Improved the GUI in multiples ways.

    Enabled stopping the tracking process.

    Corrected the multiple motion model tracking.

  • Version 1.0.1.6 • Released on: 2012-01-16 14:46:47
    Download
    Description:

    Fix: now it uses properly the gate factor

  • Version 1.0.1.5 • Released on: 2011-12-07 16:43:09
    Download
  • Version 1.0.1.4 • Released on: 2011-12-07 16:05:37
    Download
    Description:

    update to fit with new detection data structure

  • Version 1.0.1.3 • Released on: 2011-10-06 14:40:47
    Download
    Description:

    Fix : shared files with the benchmark generator (fab)

  • Version 1.0.1.2 • Released on: 2011-10-06 14:15:39
    Download
    Description:

    Fix: GUI problem with the detection chooser (invoke later was missing). (fab)

  • Version 1.0.1.1 • Released on: 2011-10-06 14:06:38
    Download
    Description:

    stable version

  • Version 1.0.1.0b • Released on: 2011-10-06 13:36:28
    Download
    Description:

    - removed main title bar to make the interface a little smaller
    - SpotTrack now supports min max and mean intensity

    (by fab)

  • Version 1.0.0.3 • Released on: 2011-04-11 23:19:24
    Download
    Description:

    changed incorrect virtual spot statement

  • Version 1.0.0.2 • Released on: 2011-03-27 14:42:51
    Download
    Description:

    fixed a jar export issue

  • Version 1.0.0.1 • Released on: 2011-03-27 14:36:58
    Download
    Description:

    Source files have been refactored and some deprecated features have been removed.

  • Version 1.0.0.0 • Released on: 2011-03-25 14:45:33
    Download