[bughht]

Summary

Adds measurement markers to the waveform viewer. Right-click a waveform (long-press on touch) and choose Add marker to drop a vertical marker. Each marker shows every channel's value where it crosses, Δt to its neighbours, and its row in a table under the plot. Placement snaps to gradient corners and block boundaries as the pointer approaches.

It also makes mT/m the default gradient unit in every host, Python included, and lets the GitHub Pages preview host several feature branches at once. Released as v0.4.1.

Live preview of this branch: https://bughht.github.io/seqeyes_plugin/preview/measurement-markers/

What it does

1. Markers (any number, labelled M1, M2, …)

   • Right-click → Add marker at Gx flat-top start (snapped) or Add marker at pointer (no snap).
   • Drag a marker to move it. This doesn't pan the view. Hold Shift to place it off the snap points.
   • To remove, right-click next to a marker, or use the × at the start of its table row, or Clear. Esc closes the menu or cancels a drag.
   • A long-press opens the menu on touch screens, and a finger drags a marker.
   • Markers are cleared when another sequence loads.

2. Snapping

   • Targets:
     • trapezoid ramp and flat-top corners;
     • extended-trapezoid breakpoints and the bends of arbitrary gradients (found by simplifying the waveform);
     • RF start, centre and end;
     • ADC start, centre and end;
     • trigger starts;
     • block boundaries.
   • Coincident targets share one label, with the pointer's own row first (e.g. Gx ramp-down end · block #12/#13).
   • A ring marks the snap point as the pointer approaches. It appears only once markers are in use, so ordinary browsing is unchanged. Snapping can be turned off from the menu, and that choice is remembered.

3. Readouts

   • On the plot: a dot and value where each marker crosses RF and Gx/Gy/Gz, and Δt brackets between neighbouring markers.
   • In the table:
     • × first, then the marker name, time, Δt, block and time within the block;
     • Gx/Gy/Gz in the current unit;
     • RF amplitude and phase, ADC sample and trigger;
     • M1/PNS while those rows are shown.
   • Copy gives tab-separated text. The table's scrollbars follow the theme.
   • Values read from the reduced whole-sequence overview of long arbitrary waveforms are marked ≈ until zoomed-in detail loads. Trapezoid corners, RF/ADC edges and block boundaries are always exact.

4. mT/m by default in the web app, VS Code, MATLAB and the Python package:

   • In the viewers, a unit someone has already chosen is still restored.
   • In Python, grad_disp defaults to "mT/m" in SeqEyesViewer, render_html and the patched Sequence.plot, and unsupported units fall back to it. Passing grad_disp="Hz/m" still works.

How it fits the two renderers

The viewer is drawn by two copies of the renderer: the bundle (VS Code) and web/index.html's own copy (web app, MATLAB). Rather than writing the feature twice:

• One module: markers.js (SeqEyesMarkers) is installed by each renderer with accessors to its own state. The last install wins, and the DOM is wired once.
• Event handling: the module owns its listeners in the capture phase on #cc. Grabbing a marker therefore pre-empts both renderers' pan handlers, and neither copy's mouse or touch code changed.
• Renderer changes: each renderer adds one line to its overlay pass and a reset on each load path.

Transport

packSequenceBlocks now also sends:

• rf.c: the RF centre, which TE and TR are measured from.
• r: 1 on waveforms whose samples the overview reduced. It is written only when set, and exact detail windows never carry it.

Preview workflow

preview-pages.yml now builds main at the root plus every branch in PREVIEW_BRANCHES under /preview/<branch>/, so one preview no longer wipes another. Notes:

• On main this workflow does nothing on its own; it runs for pushes to listed branches or by hand.
• feature/measurement-markers was added to the github-pages environment's deployment branch policy. That entry can be removed after merging.

Testing

• Unit: 17 new tests in test/editor/markers.test.ts (corner detection, snapping and ranking, readouts with and without detail, the marker list and table), plus a transport test for rf.c and r.
• Browser: 8 new tests in test/browser/markers.spec.ts:
  • snap to a known corner to 1e-12 s, Δt, no-snap placement;
  • Esc and outside click, overlay pixels, zoom, a new file;
  • remove and clear, drag with and without Shift, the remembered setting;
  • the M1 column, touch long-press and drag.
• VS Code renderer: 1 new test in vscode-webview.spec.ts.
• Changed: the persisted-settings test now picks G/cm, since choosing the default proved nothing. The Python default-unit tests now expect mT/m.
• Python: pytest passes (27 passed, 1 skipped).
• Full suites: npm run check (687 unit tests), all 111 browser tests and npm run test:vscode pass. CI is green for every commit.
• Live preview: checked by driving it in a browser. Two markers on the demo GRE's readout corners give Δt = 3.2000 ms, exactly 128 × 25 µs.
• VS Code 1.85.2: checked in a real window. Right-click shows the marker menu, not VS Code's, and adding a marker fills the table.

Files changed

• src/editor/webview/assets/markers.js (new)
• src/editor/webview/assets/drawing.js, state.js, interaction.js, prefs.js, prefs-ui.js, styles.css, template.html
• web/index.html
• src/editor/blockTransport.ts
• scripts/build-webview.mjs
• .github/workflows/preview-pages.yml
• README.md (Features, Usage, and a new "Measurement markers" section)
• Tests: test/editor/markers.test.ts (new), test/browser/markers.spec.ts (new), test/pulseq/block-transport.test.ts, test/browser/vscode-webview.spec.ts, test/browser/persisted-settings.spec.ts
• Python: python/src/seqeyes/_plot.py, _renderer.py, resources/viewer.html, python/tests/test_plot.py, python/examples/demo.ipynb
• Release v0.4.1: package.json, package-lock.json, python/pyproject.toml, python/src/seqeyes/__init__.py, matlab/toolboxInfo.xml
• Generated bundles: web/*-bundle.js, web/styles.css, python/src/seqeyes/resources/*-bundle.js

🤖 Generated with Claude Code