illumination op• Data kinds: none → pairs (an op determined by its arguments alone — it takes no image or data input)
• Call: import illumdesign; illumdesign.lighting_sweep(surface='glossy', slope_deg=10.0, elevations_deg=None, radius_mm=60.0, n=24, camera_height_mm=300.0, kind='ring') (or opsoptics.get("lighting_sweep"))
Defect contrast versus ring-light elevation angle (`pairs`).
A ring (or bar) of *radius_mm* is placed at heights giving each elevation
in *elevations_deg* (default 5°…85° in 5° steps) and :func:defect_contrast
is evaluated for a facet of *slope_deg* on *surface*. Returns `(n, 2)`
`[elevation, max_abs contrast]`; the maximum tells the designer where to
put the light. On a glossy surface the peak is at elevation ``90° − 2 ×
slope`` (the facet mirrors the light into a camera on axis) — the closed
form `tests/test_illumdesign.py` pins.
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.
• mv_illumination_practice — 照明の実務知識 — 波長・偏光・点灯方式・外光・安全
• 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.
• illumination_design_demo — py -3.11 examples/illumination_design_demo.py
pairs as input)—
illumination)light_source · irradiance_map · illumination_uniformity · defect_contrast · illumination_design
*Provenance: illumdesign.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.