Track Analyzer
Track Analyzer visualizes and quantifies objects that have already been tracked through time. It does not perform tracking: it starts with a table of trajectories and, optionally, the corresponding movie.
Explore motion through trajectory plots, velocity and acceleration measurements, mean squared displacement (MSD), diffusion estimates, and 2D Voronoi analysis. Grid-based maps summarize quantities such as velocity, divergence, and curl. Spatial and temporal filtering makes it possible to analyze or compare subsets and to investigate where selected objects came from and where they go.
The analysis pipeline
- Prepare the inputs. Provide a CSV or TXT table containing track IDs,
frame numbers, X and Y coordinates, and optionally Z coordinates and other
measurements. Supply metadata such as spatial and time scales. An optional
TIFF image can be used as a background. For TrackMate, export the spots
table. A preprocessed
data_base.pcan be reused. - Select trajectories. Filter by spatial ranges, time windows, and track length. Depending on the interface, select individual IDs or tracks passing through a region at a given time.
- Analyze trajectories. Plot tracks and motion parameters, compute MSD and model fits, or estimate local area and density with 2D Voronoi tessellation.
- Create maps and compare results. Analyze measurements on a regular 2D grid and compare or pool saved trajectory analyses. Compared datasets must use matching length and time units.
- Inspect outputs. Depending on the selected analyses, results include tables, plots, TIFF stacks, and configuration files.
See the pipeline overview and outputs guide for details.
Choose an interface
The interfaces use the same underlying pipeline, but do not all expose the same settings or interactive features.
| Interface | Best suited for | Guide |
|---|---|---|
| napari | Interactive local analysis, image and track previews, ROI drawing, maps, and synthetic datasets | napari plugin |
| Jupyter notebook | A local step-by-step workflow with widgets and access to Python code | Notebook |
| Galaxy | Browser-based jobs without a local installation | Galaxy |
| Command line | Configuration-file-driven local or remote analysis | Command line |
Getting started
Galaxy
Open the Track Analyzer Galaxy tool, upload the tracking table and optional image, configure the job, and retrieve its results from the Galaxy history. See the Galaxy guide for input requirements and instructions.
Local installation
Local workflows require Python 3.11 or newer. To use the napari plugin, install napari 0.10 or newer with a Qt 6 backend. For example, with Miniconda, run the following in a terminal (or Anaconda PowerShell on Windows):
conda create -y -n track-analyzer-napari -c conda-forge python=3.11
conda activate track-analyzer-napari
conda install -c conda-forge "napari>=0.10" pyqt6
From the root of a Track Analyzer source checkout, install the plugin and its dependencies:
python -m pip install -e ".[napari]"
The checkout also provides the notebook, command-line tools, and example
datasets. Activate the environment before starting a local workflow.
Alternatively, install the package from PyPI with
python -m pip install track-analyzer; plugin availability depends on the
published release. The notebook and examples are available in the source
checkout.
napari
Run python -m napari and open Plugins > Track Analyzer. Load and map
your table, save metadata and the preprocessed database, then configure
filters and run trajectory or map analysis. The separate Plugins > Synthetic
Dataset Generator widget creates synthetic tracks and can display them in
the viewer.
See the napari guide for previews, comparison, export settings, and the synthetic dataset generator.
Jupyter notebook
From the checkout, run jupyter notebook and open run_TA.ipynb. Execute
the cells in order to load data, configure filtering, and run analyses. See
the notebook guide.
Command line
Prepare a dataset directory with positions.csv and info.txt, then create
and edit the default configuration files:
TA_config /path/to/dataset
traj_analysis /path/to/dataset
map_analysis /path/to/dataset
See the command-line guide for input
requirements, optional images, parallel TIFF rendering, and synthetic data.
Each command also provides --help.
Examples and documentation
The checkout includes synthetic datasets in example/. The examples guide also describes how to obtain real and synthetic data.
Read the full documentation. See the release notes for version history and the upcoming napari plugin. To build it locally from the repository root:
python -m pip install -r doc/requirements.txt
python -m sphinx -b html doc/source doc/build/html
Open doc/build/html/index.html in a browser. For local installation and
napari troubleshooting, see the installation guide.
License
Track Analyzer is distributed under the GNU GPL, version 3 or later. See COPYING.
Metadata
Release files for track-analyzer 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| track_analyzer-0.6.0.tar.gz | 15.1 MB | Without provenance | Details for track_analyzer-0.6.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| track_analyzer-0.6.0-py3-none-any.whl | Python 3 | none | any | Details for track_analyzer-0.6.0-py3-none-any.whl |
Total release size: 15.2 MB
Release files / track_analyzer-0.6.0.tar.gz
| Download URL | track_analyzer-0.6.0.tar.gz |
|---|---|
| Size | 15.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7df537fc5cc4fb58de77991cfbdce4d77765fb17873f2849c98319020955865d
|
|
BLAKE2b-256 checksum How to use checksums |
9047fc83abd5e33984198853662a1e564648189d4988ae0076ad2efb0c0ec967
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.18
|
Release files / track_analyzer-0.6.0-py3-none-any.whl
| Download URL | track_analyzer-0.6.0-py3-none-any.whl |
|---|---|
| Size | 167.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b0dcd1e9e8bff067c10f74929569f671a3d8b230f4963086783276f7ee3443d4
|
|
BLAKE2b-256 checksum How to use checksums |
824469cb09f718adf4c27ff497991b5987d7d7958e954e4c26ba6f0028d68da3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.18
|
Security for track-analyzer 0.6.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.