webSMLM — Documentation
A detailed reference for every button, control, parameter and module — complementary to the in-app Quick guide, which stays deliberately sparse (a quick walkthrough, not a manual). This file is the place for the detail that doesn’t belong in a UI popover: exact defaults, min/max/step, what each control actually does under the hood, and the on-disk file formats.
Scope note: this describes behaviour, not implementation — it should stay
accurate without needing a rewrite on every internal refactor. When editing
webSMLM.html, prefer expanding this file over adding a long inline comment;
a comment should only explain a non-obvious why, not what (see
CLAUDE.md). If a described default/range drifts out of sync with the
PARAMS registry, PARAMS is authoritative — this file describes it, not
the other way round.
This file is also the source for the app’s own in-app “more info…”
popups (the .hint divs next to each sidebar control group — a third,
separate layer from both this manual and the sparse Quick guide modal).
Each popup’s content lives inside a <!-- HINT:<name> --> ... <!-- /HINT:<name> --> marker below, kept in sync with webSMLM.html by tools/sync_hints.mjs
— edit the marker, then run the script; never hand-edit a .hint div
directly (see CLAUDE.md’s Documentation build section for the full
mechanism).
References below point at webSMLM.html’s own id=/function names, which
stay stable across versions — exact line numbers aren’t given, since they
drift as the file grows.
Documentation
- 1 · Exploring the user interface
- 2 · Module reference
- PARAMS registry (
params) - Load data (
in/out) - Simulation (
simulation) - Simulation guide: step by step
- What one Simulate movie does
- Quick start: your first scored movie
- Reproducibility and comparisons
- Choosing a structure
- Depth
- The PSF
- Physics detail and the Fluorophore fields
- Background
- Camera
- Drift and field of view
- Comparing to the ground truth
- Recipes
- Performance
- From the log terminal
- Limits worth knowing
- Localisation (
detect) - Localisation (
fit) - Rendering (
render) - Worker dispatch (
workers) - Localisation (
export) - 3D calibration (
3D calibration) - Drift correction (
drift) - Ground-truth scoring (
validation) - Localization precision (NeNA & FRC) (
locprecision) - Pairing for sSMLM or FRET (
sSMLM) - Time traces and FRET (
smFRET)
- PARAMS registry (
- of frames**) makes explicit that this module is also a plain time-traces
- 3 · Parameters (
PARAMSregistry)- Memory, rotation, GPU & streaming (
in/out) - Simulation (
simulation) - Ground-truth scoring (
validation) - Localisation (
detect) - Localisation (
fit) - Gain & offset estimation (PCFO) (
fit) - Rendering of localisations (
render) - Worker dispatch (
workers) - Localisation (
export) - 3D calibration (
3D calibration) - Drift correction & precision (NeNA & FRC) (
drift) - Pairing for sSMLM or FRET settings (
sSMLM) - Time traces and FRET settings (
smFRET) - Single-particle tracking (
spt) - Pipeline behaviour (
pipeline) - Pipeline: preview / export tuning (
pipeline)
- Memory, rotation, GPU & streaming (
- 4 · Settings JSON format
- 5 · Table & filter grammar
- 6 · CSV export format
- 7 · Calibration JSON format
- 8 · Headless API (
window.webSMLM) - 9 · References & further reading
- 10 · Changelog