design op• Data kinds: table → table
• Call: import fullseye as fs; fs.ledger.set_vignetting(system, fields=None, rings=8, wavelength_um=None, mode='four') (to call the implementation directly, import raytrace; raytrace.set_vignetting(system, fields=None, rings=8, wavelength_um=None, mode='four'); from the registry, opsoptics.get("set_vignetting"))
Compute the vignetting factors that remove every aperture-clipped ray, as "set vignetting" does (table).
For each field (a list of radial field values; default the existing records' fields, else the system's own field) the real-ray-aimed pupil is searched along ±x and ±y for the edge of the clear region (bisection to 1e-13): VDX, VDY are the centres and VCX, VCY one minus the half-widths, VAN is 0.
*mode* "four" (the default) is the definition of the format's user guide (knowledge-base article
KA-01393): the factors are chosen so that exactly the four marginal rays — top (0, 1), bottom (0, -1), left (-1, 0) and right (1, 0) of the vignetted pupil — pass every aperture. It is what reproduces the factors recorded in a file, but when the clear region is not an ellipse (e.g. two offset circles) rays between the four can still be clipped. "grid" is the stricter option: if a rings-ring hexapolar grid plus a 72-point rim of the resulting ellipse still has clipped rays the ellipse is shrunk about its centre until none is, so afterwards no ray of the grid is clipped. A field with nothing clipped gets all-zero factors (to 1e-9 and in practice exactly). A field whose chief ray is itself clipped raises ValueError. Returns a copy of *system* with aim="stop" (the factors are fractions of the stop pupil, so they belong to real-ray aiming) and the records for those fields replaced; vignetting_set records the fields, grid (rings, n_checked rays per field), and wavelength the factors were verified on.
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.
• 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.
• optical_design_metrics — py -3.11 examples/optical_design_metrics.py
table as input)abcd_matrix · wavefront_stats · sfr_from_edge · paraxial_trace · seidel_coefficients · spot_stats · tolerance_analysis · wavefront_from_opd
design)lens_system · thick_lens · glass · example_system · glass_catalog · sellmeier · paraxial_trace · seidel_coefficients
*Provenance: raytrace.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.