# trackmate-sc/trackmate architecture

> Architecture diagram of the GitHub repository trackmate-sc/trackmate, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/trackmate-sc/trackmate
- Repository: https://github.com/trackmate-sc/trackmate

## Overview

TrackMate is a Fiji plugin for single-particle tracking in life-science images. A user works through a wizard to configure segmentation and particle linking, review or edit results, analyze tracks, and export them. The repository separates the central model from detection, tracking, feature analysis, visualization, and persistence; extension providers and post-processing actions support additional algorithms and workflows. The README documents the overall user flow and capabilities; source excerpts are partial, so individual implementation-level calls are not inferred where they are not shown.

Main entry points: [`src/main/java/fiji/plugin/trackmate/Model.java`](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/Model.java) (Tracking model), [`src/main/java/fiji/plugin/trackmate/TrackMate.java`](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/TrackMate.java) (Workflow engine), [`src/main/java/fiji/plugin/trackmate/gui/wizard/WizardController.java`](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/gui/wizard/WizardController.java) (Tracking wizard), [`src/main/java/fiji/plugin/trackmate/action`](https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/action) (Post-processing actions)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["User workflow"]
  node_wizard["Tracking wizard"]
  node_settings["Image settings<br/>[Settings.java]"]
  node_orchestrator["Workflow engine<br/>[TrackMate.java]"]
end

subgraph group_engine["Tracking engine"]
  node_detection["Spot detection"]
  node_spotdata["Spot records<br/>[Spot.java]"]
  node_spotcollection["Spot collection"]
  node_tracking["Particle linking"]
  node_model["Tracking model<br/>[Model.java]"]
  node_trackmodel["Track graph<br/>[TrackModel.java]"]
end

subgraph group_analysis["Analysis and views"]
  node_features["Feature analysis"]
  node_filters["Spot and track filters<br/>[FeatureFilter.java]"]
  node_plots["Feature plots"]
  node_visualization["Tracking views"]
  node_displaysettings["View settings"]
end

subgraph group_extensions["Extensions and editing"]
  node_labkit["Label editing"]
  node_providers["Algorithm providers"]
  node_actions["Post-processing actions"]
end

subgraph group_persistence["Persistence and export"]
  node_xml["TrackMate XML<br/>[TmXmlWriter.java]"]
  node_csv["CSV export<br/>[CSVExporter.java]"]
end

node_user(("Image analyst"))
node_external(("Analysis software"))

node_user -->|"configures workflow"| node_wizard
node_wizard -->|"sets parameters"| node_settings
node_wizard -->|"runs tracking"| node_orchestrator
node_orchestrator -->|"segments spots"| node_detection
node_orchestrator -->|"links particles"| node_tracking
node_detection -.->|"produces detections"| node_spotcollection
node_spotcollection -->|"holds spots"| node_spotdata
node_tracking -->|"reconstructs tracks"| node_trackmodel
node_model -->|"manages spots"| node_spotcollection
node_model -->|"manages tracks"| node_trackmodel
node_orchestrator -->|"stores results"| node_model
node_model -->|"supports analysis"| node_features
node_features -->|"feeds plots"| node_plots
node_model -->|"filters results"| node_filters
node_model -->|"renders results"| node_visualization
node_user -->|"reviews results"| node_visualization
node_displaysettings -->|"configures display"| node_visualization
node_user -->|"edits labels"| node_labkit
node_providers -.->|"supplies algorithms"| node_detection
node_providers -.->|"supplies algorithms"| node_tracking
node_user -->|"runs post-processing"| node_actions
node_actions -.->|"exports results"| node_xml
node_actions -.->|"exports tables"| node_csv
node_xml -->|"shares data"| node_external
node_csv -->|"shares data"| node_external

click node_wizard "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/gui/wizard/WizardController.java"
click node_settings "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/Settings.java"
click node_orchestrator "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/TrackMate.java"
click node_detection "https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/detection"
click node_spotdata "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/Spot.java"
click node_spotcollection "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/SpotCollection.java"
click node_tracking "https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/tracking"
click node_model "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/Model.java"
click node_trackmodel "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/TrackModel.java"
click node_features "https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/features"
click node_filters "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/features/FeatureFilter.java"
click node_plots "https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/features"
click node_visualization "https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/visualization"
click node_displaysettings "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/gui/displaysettings/DisplaySettings.java"
click node_labkit "https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/gui/editor/labkit"
click node_providers "https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/providers"
click node_actions "https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/action"
click node_xml "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/io/TmXmlWriter.java"
click node_csv "https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/io/CSVExporter.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_wizard,node_settings,node_orchestrator toneBlue
class node_detection,node_spotdata,node_spotcollection,node_tracking,node_model,node_trackmodel toneAmber
class node_features,node_filters,node_plots,node_visualization,node_displaysettings toneMint
class node_labkit,node_providers,node_actions toneRose
class node_xml,node_csv,node_user,node_external toneIndigo
```

## Components

### User workflow

- [Tracking wizard](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/gui/wizard/WizardController.java): `src/main/java/fiji/plugin/trackmate/gui/wizard/WizardController.java`
- [Image settings](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/Settings.java): `src/main/java/fiji/plugin/trackmate/Settings.java`
- [Workflow engine](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/TrackMate.java): `src/main/java/fiji/plugin/trackmate/TrackMate.java`

### Tracking engine

- [Spot detection](https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/detection): `src/main/java/fiji/plugin/trackmate/detection`
- [Spot records](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/Spot.java): `src/main/java/fiji/plugin/trackmate/Spot.java`
- [Spot collection](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/SpotCollection.java): `src/main/java/fiji/plugin/trackmate/SpotCollection.java`
- [Particle linking](https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/tracking): `src/main/java/fiji/plugin/trackmate/tracking`
- [Tracking model](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/Model.java): `src/main/java/fiji/plugin/trackmate/Model.java`
- [Track graph](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/TrackModel.java): `src/main/java/fiji/plugin/trackmate/TrackModel.java`

### Analysis and views

- [Feature analysis](https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/features): `src/main/java/fiji/plugin/trackmate/features`
- [Spot and track filters](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/features/FeatureFilter.java): `src/main/java/fiji/plugin/trackmate/features/FeatureFilter.java`
- [Feature plots](https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/features): `src/main/java/fiji/plugin/trackmate/features`
- [Tracking views](https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/visualization): `src/main/java/fiji/plugin/trackmate/visualization`
- [View settings](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/gui/displaysettings/DisplaySettings.java): `src/main/java/fiji/plugin/trackmate/gui/displaysettings/DisplaySettings.java`

### Extensions and editing

- [Label editing](https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/gui/editor/labkit): `src/main/java/fiji/plugin/trackmate/gui/editor/labkit`
- [Algorithm providers](https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/providers): `src/main/java/fiji/plugin/trackmate/providers`
- [Post-processing actions](https://github.com/trackmate-sc/trackmate/tree/master/src/main/java/fiji/plugin/trackmate/action): `src/main/java/fiji/plugin/trackmate/action`

### Persistence and export

- [TrackMate XML](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/io/TmXmlWriter.java): `src/main/java/fiji/plugin/trackmate/io/TmXmlWriter.java`
- [CSV export](https://github.com/trackmate-sc/trackmate/blob/master/src/main/java/fiji/plugin/trackmate/io/CSVExporter.java): `src/main/java/fiji/plugin/trackmate/io/CSVExporter.java`

### Other components

- **Image analyst**
- **Analysis software**

## Connections

- Image analyst → Tracking wizard: configures workflow
- Tracking wizard → Image settings: sets parameters
- Tracking wizard → Workflow engine: runs tracking
- Workflow engine → Spot detection: segments spots (evidence: `src/main/java/fiji/plugin/trackmate/TrackMate.java`)
- Workflow engine → Particle linking: links particles (evidence: `src/main/java/fiji/plugin/trackmate/TrackMate.java`)
- Spot detection → Spot collection: produces detections
- Spot collection → Spot records: holds spots (evidence: `src/main/java/fiji/plugin/trackmate/SpotCollection.java`)
- Particle linking → Track graph: reconstructs tracks
- Tracking model → Spot collection: manages spots (evidence: `src/main/java/fiji/plugin/trackmate/Model.java`)
- Tracking model → Track graph: manages tracks (evidence: `src/main/java/fiji/plugin/trackmate/Model.java`)
- Workflow engine → Tracking model: stores results (evidence: `src/main/java/fiji/plugin/trackmate/TrackMate.java`)
- Tracking model → Feature analysis: supports analysis (evidence: `src/main/java/fiji/plugin/trackmate/Model.java`)
- Feature analysis → Feature plots: feeds plots
- Tracking model → Spot and track filters: filters results (evidence: `src/main/java/fiji/plugin/trackmate/Model.java`)
- Tracking model → Tracking views: renders results (evidence: `src/main/java/fiji/plugin/trackmate/visualization/trackscheme/utils/SearchBar.java`)
- Image analyst → Tracking views: reviews results
- View settings → Tracking views: configures display
- Image analyst → Label editing: edits labels
- Algorithm providers → Spot detection: supplies algorithms
- Algorithm providers → Particle linking: supplies algorithms
- Image analyst → Post-processing actions: runs post-processing
- Post-processing actions → TrackMate XML: exports results
- Post-processing actions → CSV export: exports tables
- TrackMate XML → Analysis software: shares data
- CSV export → Analysis software: shares data
