simulate op• Data kinds: depth → zscan
• Call: import fullseye as fs; fs.ledger.csi_stack_simulate(height_um, z_start_um=0.0, z_step_um=0.05, n_planes=241, wavelength_um=0.6, envelope_fwhm_um=2.8, envelope_sigma_um=None, bias=0.5, amplitude=0.4, reflectivity=None, noise=0.0, seed=0) (to call the implementation directly, import interferometry; interferometry.csi_stack_simulate(height_um, z_start_um=0.0, z_step_um=0.05, n_planes=241, wavelength_um=0.6, envelope_fwhm_um=2.8, envelope_sigma_um=None, bias=0.5, amplitude=0.4, reflectivity=None, noise=0.0, seed=0); from the registry, opsinterferometry.get("csi_stack_simulate"))
Synthesise the (Z, H, W) scan stack an interference microscope records.
The per-pixel version of csi_signal_simulate: every pixel of the *height_um* map gets its own coherence envelope centred on its own height, on a shared scan grid. The scan axis is FIRST — a stack is what a camera streams while the objective moves, one frame per plane — which is the same layout as a video (T, H, W) and *not* the (H, W, T) of a photoncount.dtof_cube_simulate histogram cube.
That resemblance to video is not cosmetic and it is measured, not assumed:
handing a translating-grating clip to csi_height_map does not raise, it returns a height map (see the type note in opsinterferometry for the numbers). The registry therefore declares a separate zscan type.
height_um: 2-D (H, W) map of true surface heights, in the scan's own
coordinate. Every height must lie inside the scan range.
reflectivity: optional (H, W) map of per-pixel fringe-amplitude scale
(>= 0). None = uniform 1. A pixel with reflectivity 0 has
no fringes at all and csi_height_map will refuse it
rather than report the first plane.
(the remaining parameters are csi_signal_simulate's, applied to every pixel; noise is sampled once for the whole stack from *seed*.)
Returns a float64 (n_planes, H, W) stack.
Ground truth: with noise=0, csi_height_map(stack, ..., mode="gaussian") returns *height_um* with an RMS error of 2.08e-06 um over a tilted plane spanning 5.0-7.0 um of a 0-12 um scan, and the per-pixel result is bit-for-bit identical to running csi_peak_position on each column separately (both pinned in the tests). Widening the same plane to 2.0-10.0 um degrades that to 7.06e-03 um — envelope truncation at the scan ends, not the estimator.
Raises ValueError: everything csi_signal_simulate raises, plus a non-2-D / empty *height_um*, a *reflectivity* that is negative or a different shape, any height outside the scan range, and a stack over MAX_STACK_ELEMENTS (n_planes*H*W grows fast — 241 planes of 256x256 is 1.9x the cap). The element cap is applied before the float64 promotion of *height_um*, not after.
• coherence_scanning family guide
• Sample-data catalog (download URLs / licences) — 2-D uses skimage.data (BSD/public domain) plus synthetic images; 3-D lists download URLs for real data sources (Stanford, PDS, …).
• Operator provenance and references — the sources of the research/methods this op family came from.
• The canonical algorithm (author, year) and its uses are named in the family usage guide above.
• coherence_scanning — py -3.11 examples/coherence_scanning.py
• poc_interferometry_step — py -3.11 examples/poc_interferometry_step.py
zscan as input)csi_height_map · csi_contrast_map
simulate)csi_signal_simulate · chromatic_confocal_simulate
*Provenance: interferometry.py — INTERFEROMETRY operator registry. This per-op note is generated by tools/opdocs.py md (do not hand-edit).*
© 2026 Kazufumi Furuse — Fullseye operator documentation. Licensed under Apache-2.0.