itof_wiggling_correct — OPTICS itof op

• Data kinds: table → table

• Call: import fullseye as fs; fs.ledger.itof_wiggling_correct(phase, frequencies_hz=None, waveform='square', n_phases=4, calibration=None, n_harmonics=2) (to call the implementation directly, import itof; itof.itof_wiggling_correct(phase, frequencies_hz=None, waveform='square', n_phases=4, calibration=None, n_harmonics=2); from the registry, opsoptics.get("itof_wiggling_correct"))

Usage

Phase and depth with the harmonic cyclic error (wiggling) corrected. Returns a table.

> The detailed description below is the original text — the summary and the headings are translated.

変調と復調が矩形波だと、相関は三角波(waveform="square")になり、K 段の推定は奇数次の高調波を基本波に折り返す。4 段なら真の位相 φ が第 1 象限にあるとき u = 2φ/π として推定は atan(u / (1 − u)) になり、誤差は周期 π/2 で波打つ(最大 ±0.071 rad 程度、20 MHz で ±8.5 cm)。

• 模型(*calibration* なし): *waveform* の相関で「真の位相 → 推定の位相」の表を作り(単調でなければ拒否)、逆に引く。

• 較正(*calibration* = (measured_phase, true_phase)、同じ周波数の 1-D の組): 誤差 e(φ_m) を c_0 + Σ_{j=1..J} (a_j cos(jKφ_m) + b_j sin(jKφ_m))(周期 2π/K の調和、J = *n_harmonics*)で最小二乗に当て、φ_m − e(φ_m) を返す(c_0 は距離のオフセット = 系の遅延)。

*phase* は itof_phase_amplitude の表か、(F, ...) の位相の配列(周波数ごとに同じ補正)。

返す dict: phase(補正後、[0, 2π))、depth(周波数が分かれば、折り返したまま)、correction(足した量)、model("lut" か "fit")、coefficients(較正のとき)、fit_rms(較正の残差 [rad])。

Raises ValueError: 位相が非有限 / waveform が不正・推定が単調でない / 較正の組の形が合わない・未知数より少ない / n_harmonics が 1〜8 でない。

Family-wide input contract (fail-closed)

Every optics op validates its input before computing (nothing slips through silently):

• Units are baked into the argument name — _mm / _um / _deg / _mrad. Confusing mm with µm does not crash; it yields a plausible-looking wrong answer, so the name prevents it. Nothing here guesses the unit from the magnitude.

• Strings raise ValueError — float('50') succeeds, so an unparsed configuration value would slip through as a length (measured: thin_lens('50', '200') returned a plausible 66.667 mm). bool is refused too, as the implicit promotion True == 1.

• complex / masked arrays raise ValueError (real-valued slots only; silently dropping the imaginary part or peeling off the mask is refused). NaN/Inf raises ValueError on every input.

• Division by zero and its relatives are refused by name: focal length 0, radius of curvature 0, refractive index <= 0, a fully opaque aperture (all zeros, so the normalisation is 0/0), a PSF whose sum is <= 0, a Stokes vector with S0 = 0, and an object sitting at the front focal point (the image is at infinity).

• Only two ops return a non-finite value, and both state it as a contract: depth_of_field returns far_mm = inf beyond the hyperfocal distance (that is what the hyperfocal distance means), and gaussian_beam returns wavefront_radius_mm = inf at the waist (the radius of curvature of a plane wavefront). Both also return a finite companion (far_is_infinite / curvature_per_mm). Any other silent NaN/Inf is detected internally and raises ValueError — "float64 overflowed" and "the answer is infinite" are different claims, so the first is never returned wearing the face of the second.

• Size caps: generated grids are capped by optics.MAX_GRID (4096); supplied fields/PSFs/apertures by optics.MAX_FIELD_ELEMENTS (2^24); ABCD element chains by optics.MAX_SYSTEM_ELEMENTS (1024); Zernike by MAX_ZERNIKE_TERMS (512) / MAX_ZERNIKE_ORDER (40) / MAX_ZERNIKE_BASIS (2^25). This closes, fail-closed, the paths where a small argument triggers a huge internal allocation (measured: n_max=40 × 4096² needs 108 GB).

• Physically impossible states are refused too: a Stokes vector with degree of polarisation > 1, negative transmittance, negative intensity, and invalid Zernike indices such as n-|m| odd.

Detailed usage guide

• optics_imaging family guide

References (sample data, literature)

• 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.

Runnable examples (verified samples that actually call this op)

• poc_itof_multifreq — py -3.11 examples/poc_itof_multifreq.py

Ops the type connects to (they accept table as input)

abcd_matrix · wavefront_stats · sfr_from_edge · paraxial_trace · seidel_coefficients · spot_stats · tolerance_analysis · wavefront_from_opd

Same category (itof)

itof_capture · itof_phase_amplitude · itof_noise_budget · itof_unwrap_multifreq · itof_unwrap_error_rate · itof_multipath_separate · itof_flying_pixel_mask


*Provenance: itof.py — OPTICS 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.