Cell tracking with btrack presets and parameter optimization
Project description
napari-easytrack
napari-easytrack is a napari plugin for automated parameter tuning in cell tracking. It optimises
btrack obtaining a set of optimal tracking parameters for a dataset. Using
that optimal set of parameters, napari-easytrack can then track the cells in the dataset,
improving tracking accuracy and reducing manual correction time.
napari-easytrack provides two widgets in napari:
- An optimization widget that optimizes tracking parameters based on a small subset of manually annotated ground-truth data.
- A tracking widget that uses the optimized parameters to track the entire dataset. Here, we provide different tracking presets so users can choose the one that best fits their data without optimization. If no preset fits the data, users should try to optimize the parameters first with the optimization widget.
Installation
Create a venv environment with Python 3.11 (recommended) or Python 3.10.
python -m venv napari_easytrack-env
First, install napari.
Then, install easytrack via pip:
python -m pip install napari-easytrack
To install the latest development version of EpiTools clone this repository
and run
python -m pip install -e .
Usage
To use napari-easytrack, first launch napari:
napari
Once in napari, click on the "Plugins" menu, then select "napari-easytrack" and click "Tracking" to open the tracking
widget. We recommend starting with the Tracking widget to test the plugin with the provided presets.
Tracking Widget
Once in the Tracking widget, you can select one of the presets from the dropdown menu:
Epithelial cells: for tracking epithelial cells in 2D+time datasets.Epithelial cells (Z-tracking): for tracking epithelial cells in 3D (space) datasets.Custom JSON: if none of the presets fit your data, you can provide a custom JSON file with tracking parameters optimised for your dataset. You can obtain this JSON file by first using theParameter tuningwidget.
Once you have selected your presets, select the "Segmentation Layer" to apply the tracking to and click "Apply Tracking". We also provide, in case it is needed, a "Clean Segmentation" and "Remove Small Objects" to improve the provided segmentation. In addition, you can also save your own configuration of parameters as a JSON file for future use by clicking on "Save Config (JSON)".
Parameter tuning Widget
To optimise your own tracking parameters specific to your dataset, you are required to provide some ground-truth data with
cells segmented and tracked. You will select this dataset as "Ground Truth Layer" in the Parameter tuning widget. As a
first trial, we recommend using a small subset of your data (e.g., 10-20 frames) with a few cells tracked (e.g., 5-10
cells).
With all the default parameters, click on "Start Optimization" to begin the optimisation process. You can cancel the
process at any time by clicking on "Stop Optimization". Once the optimisation is finished, you can save the optimal
parameters as a JSON file by clicking on "Save Config". You can then use this JSON file in the Tracking widget to
track
your entire dataset, selecting "Custom JSON" in the presets dropdown menu.
Issues
If you encounter any problems, please file an issue along with a detailed description.
Citation
If you use napari-easytrack in your research, please cite the following paper:
@software{Huygelen_napari-easytrack,
author = {Huygelen, Tim and Lowe, Alan and Mao, Yanlan and Vicente-Munuera, Pablo},
license = {MIT},
title = {{napari-easytrack}},
url = {https://github.com/timsmsmsm/easytrack},
year = {2026},
doi = {10.5281/zenodo.18200897},
}
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file napari_easytrack-0.1.6.tar.gz.
File metadata
- Download URL: napari_easytrack-0.1.6.tar.gz
- Upload date:
- Size: 1.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
357f57d86c696e9be8371645fa93937116048989e0c9f1d7db96cd13de44924d
|
|
| MD5 |
d694cbfd16e847e6ca4e5390782f62f9
|
|
| BLAKE2b-256 |
c026eddceca492088672761b2d903077b225fc64b6a82f240703759cba17f8a6
|
Provenance
The following attestation bundles were made for napari_easytrack-0.1.6.tar.gz:
Publisher:
python-publish.yml on timsmsmsm/easytrack
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
napari_easytrack-0.1.6.tar.gz -
Subject digest:
357f57d86c696e9be8371645fa93937116048989e0c9f1d7db96cd13de44924d - Sigstore transparency entry: 908071277
- Sigstore integration time:
-
Permalink:
timsmsmsm/easytrack@c745c32bf45a0343561996b928594f8031954e5e -
Branch / Tag:
refs/tags/v0.1.6 - Owner: https://github.com/timsmsmsm
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@c745c32bf45a0343561996b928594f8031954e5e -
Trigger Event:
push
-
Statement type:
File details
Details for the file napari_easytrack-0.1.6-py3-none-any.whl.
File metadata
- Download URL: napari_easytrack-0.1.6-py3-none-any.whl
- Upload date:
- Size: 53.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
95c39811d8e307e9b281f072a44022803aa54ed6977045e5fe992489096a9958
|
|
| MD5 |
f09fe24b63c72d88470890b7a2ac7c9f
|
|
| BLAKE2b-256 |
fac384b2cf387af648e0b0df6acacdafa191a2f8adf1e8da7df7099b80364b51
|
Provenance
The following attestation bundles were made for napari_easytrack-0.1.6-py3-none-any.whl:
Publisher:
python-publish.yml on timsmsmsm/easytrack
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
napari_easytrack-0.1.6-py3-none-any.whl -
Subject digest:
95c39811d8e307e9b281f072a44022803aa54ed6977045e5fe992489096a9958 - Sigstore transparency entry: 908071281
- Sigstore integration time:
-
Permalink:
timsmsmsm/easytrack@c745c32bf45a0343561996b928594f8031954e5e -
Branch / Tag:
refs/tags/v0.1.6 - Owner: https://github.com/timsmsmsm
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@c745c32bf45a0343561996b928594f8031954e5e -
Trigger Event:
push
-
Statement type: