ultrack-imagej
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.0%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: royerlab
- License: gpl-3.0
- Language: Java
- Default Branch: main
- Size: 2.77 MB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
- Releases: 0
Metadata Files
README.md
Ultrack FIJI's plugin
Large-scale cell tracking under segmentation uncertainty.
Overview
Ultrack is a method for large-scale 3D cell-tracking through a segmentation selection approach. It is effective at tracking cells across large microscopy datasets on two fronts: (i) It can solve problems containing millions of segmentation instances in terabyte-scale 3D+t datasets; (ii) It achieves competitive results with or without deep learning, which requires 3D annotated data, that is scarce in the fluorescence microscopy field. The proposed method computes cell tracks and segments using a hierarchy of segmentation hypotheses and selects disjoint segments by maximizing the overlap between adjacent frames. We show that this method achieves state-of-the-art results in 3D images from the cell tracking challenge and has a faster integer linear programming formulation. Moreover, our framework is flexible and supports segmentations from off-the-shelf cell segmentation models and can combine them into an ensemble that improves tracking.
Description
Installation
The Ultrack plugin is a Java client for Python's Ultrack tracking software. The user needs to have
Python installed in the system, preferably managed by conda.
The FIJI plugin depends on Ultrack's optional functionalities.
Therefore, installation must include ultrack[api].
For example:
bash
pip install 'ultrack[api]'
For additional installation instructions, please refer to the Ultrack documentation.
This plugin will call the Ultrack routines under the hood, enabling cell tracking in 2D+t and 3D+t datasets.
FIJI integration
The ultrack plugin is available after selecting the update site for ultrack in FIJI by clicking HELP → Update → Manage Update Sites and then searching for Ultrack. To activate the update site, click the checkbox in the Activate column, the leftmost one. Right after that, click Apply and Close and then Apply Changes in the now-enabled button at the bottom of the previous ImageJ Update window. That will trigger the download of the Ultrack plugin.
After that, FIJI restart is required, and then the Ultrack plugin will be available in the Plugins→Tracking→ Ultrack menu.
How to Use
The steps below describe how to use the Ultrack plugin:
Open the image sequence to be tracked.
Click on the Plugins → Tracking → Ultrack menu. The Ultrack GUI will open.

(Optional but required in the first run) If Ultrack is correctly installed and accessible through the system path, the user can proceed to the next step. Otherwise, the user needs to set the path to the Ultrack executable in the Environment→Select Conda Path menu. It will open a dialog to select the
condaexecutable, and then the user needs to select the preferred environment, which should be one indicated with the[Ultrack found]flag.Now you should be able to start the connection with the Ultrack software by clicking the Start Ultrack Server button. The plugin will update its GUI to show the available tracking options, as shown in the figure below.

- The user should now select the desired tracking workflow in this section:

in which the user can select the desired tracking workflow. The options are: - Auto Detection From Image: which provides a way to track cells using solely the image as input; - Foreground & edges from user: which is suitable for tracking cells using edge detection and foreground segmentation provided by the user; - and Segmentation from user: which is suitable for tracking cells using segmentation labels from your favorite segmentation software, such as Stardist, Cellpose, MicroSAM or any other.
- (Optional) After selecting your desired workflow, you can tune the tracking parameters in the Settings section. The parameters are workflow-dependent, and the user can check here for more information about the parameters. Not all of them are available in the FIJI interface, Python is required for full customization.

- After setting the parameters, the user can click the Select Images button to select the image to be tracked. It is worth mentioning that some workflows, such as Manual Detection, require more than one image to be selected.

- Finally, the user can click the Run button to start the tracking process. The user can follow the tracking process in the Ultrack Log section.

- To visualize the tracking results, the user can click the View Tracks button. Then, it will request a particular image to bind the tracks. In the end, The tracking results will be shown using the TrackMate plugin.

Acknowledgments
We thank the ImageJ community for providing the necessary tools to develop this plugin, such as the FIJI platform and integrations. We also acknowledge the developers from Trackmate plugin for their work in the tool, which we rely on to visualize the tracking results.
Citation
If you find ultrack useful, please cite Ultrack as follows:
@misc{bragantini2023ultrack,
title={Large-Scale Multi-Hypotheses Cell Tracking Using Ultrametric Contours Maps},
author={Jordão Bragantini and Merlin Lange and Loïc Royer},
year={2023},
eprint={2308.04526},
archivePrefix={arXiv},
primaryClass={cs.CV}
}
Owner
- Name: Royer Lab
- Login: royerlab
- Kind: organization
- Email: loic.royer@czbiohub.org
- Repositories: 26
- Profile: https://github.com/royerlab
Official repository of the Royer Lab where all the freaking cool stuff is cooked
Citation (citation.md)
```
@misc{bragantini2023ultrack,
title={Large-Scale Multi-Hypotheses Cell Tracking Using Ultrametric Contours Maps},
author={Jordão Bragantini and Merlin Lange and Loïc Royer},
year={2023},
eprint={2308.04526},
archivePrefix={arXiv},
primaryClass={cs.CV}
}
```
GitHub Events
Total
- Issues event: 1
- Issue comment event: 1
Last Year
- Issues event: 1
- Issue comment event: 1
Committers
Last synced: 10 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Ilan Silva | i****a@g****m | 51 |
| github-actions | g****s@g****m | 6 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 1
- Total pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: 28 minutes
- Total issue authors: 1
- Total pull request authors: 2
- Average comments per issue: 1.0
- Average comments per pull request: 0.67
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 1.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- feyzanar (1)
Pull Request Authors
- ilan-theodoro (3)
- JoOkuma (2)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v3 composite
- actions/checkout v2 composite
- actions/setup-java v3 composite
- net.imagej:ij
- net.imagej:imagej-common
- net.imglib2:imglib2
- net.imglib2:imglib2-algorithm
- net.imglib2:imglib2-algorithm-gpl
- net.imglib2:imglib2-ij
- net.imglib2:imglib2-realtransform
- net.imglib2:imglib2-roi
- org.java-websocket:Java-WebSocket 1.5.6
- org.jdom:jdom2
- org.scijava:scijava-common
- org.scijava:scijava-listeners
- org.slf4j:slf4j-api 1.7.5
- org.slf4j:slf4j-log4j12 1.7.5
- sc.fiji:TrackMate
- sc.fiji:fiji-lib