false_color_metric — OPTICS pixelshift op

• Data kinds: rgbimage → table

• Call: import fullseye as fs; fs.ledger.false_color_metric(rgb, reference=None, border=0) (to call the implementation directly, import pixelshift; pixelshift.false_color_metric(rgb, reference=None, border=0); from the registry, opsoptics.get("false_color_metric"))

Usage

Amount of false colour: statistics of the colour-difference (BT.601 Cb, Cr) magnitude.

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

*reference* が無ければ被写体を無彩色とみなし、各画素の √(Cb² + Cr²) そのものを偽色とする(白黒の配線・織物・網点・解像チャートを撮った場合)。*reference* (H, W, 3) があれば、その色差との差の大きさを取る(色のある被写体)。*border* 画素ぶん四辺を除いてから数える(端の差し戻しを数えないため)。

返り値 {"mean", "rms", "p99", "max", "fraction_over_0.02", "n_pixels"}。値は入力の階調(0〜1 なら 0〜1) の色差。0.02 は 8 bit で約 5 階調。

Raises ValueError: rgb が (H, W, 3) の有限の実数でない / reference の形が違う / border が負・画像を食い尽くす。

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_pixel_shift — py -3.11 examples/poc_pixel_shift.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 (pixelshift)

pixel_shift_pattern · pixel_shift_capture · pixel_shift_merge · pixel_shift_motion_mask · pixel_shift_resolution_budget


*Provenance: pixelshift.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.