bokeh_shape — OPTICS lensrender op

• Data kinds: table → table

• Call: import fullseye as fs; fs.ledger.bokeh_shape(system, field_xy_mm=None, defocus_mm=0.5, pupil_samples=512, object_mm=None, wavelength_um=None, grid=64) -> 'dict' (to call the implementation directly, import lensrender; lensrender.bokeh_shape(system, field_xy_mm=None, defocus_mm=0.5, pupil_samples=512, object_mm=None, wavelength_um=None, grid=64) -> 'dict'; from the registry, opsoptics.get("bokeh_shape"))

• GPU: none (CPU reference implementation only)

Usage

The out-of-focus footprint of a point source - the intersection of the pupil images, the cat's eye -> dict.

The point sits at *field_xy_mm* in the object plane at *object_mm* (a height in mm; for an object at infinity a pair of angles in degrees;

default: (0, 8) degrees for an object at infinity, a height of 5 % of the object distance otherwise), the sensor is *defocus_mm* behind the system's image plane. A hexapolar pupil bundle of about *pupil_samples* rays is traced forward (raytrace.ray_bundle, which stops a ray at every semi-diameter); the rays that get through land on the shifted sensor and their convex hull is the footprint. The table has polygon_xy_mm (the hull, counter-clockwise, relative to its centroid, on the sensor axes), mask (a grid x grid boolean image of the footprint, extent_mm wide), area_mm2, the same for the on-axis point (axis_area_mm2), area_ratio (cat's eye / on-axis disc), vignetting_factor (the share of the pupil area that gets through relative to the axis, from the ray bundle), n_valid, centroid_xy_mm, symmetry_error_mm (how far the footprint is from its mirror image about the meridional plane, 0 in exact arithmetic) and the footprint points points_xy_mm. The geometric defocus disc of a point on axis has the diameter 2 |defocus| NA' (tested). The system must be axisymmetric (the field is traced along +y and rotated).

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. Exception, declared: the u_map of bottle_fit_from_pattern takes pixels that could not be measured as NaN (infinity is still refused).

• 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. Exception, declared: bottle_background_map returns NaN in u_mm for pixels whose ray is unusable (total internal reflection and the like), together with a valid mask and the counts.

• 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_photograph_through_prescription — py -3.11 examples/poc_photograph_through_prescription.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 (lensrender)

lens_scene · exit_pupil_samples · trace_sensor_rays · scene_radiance · render_scene_through_lens · render_ghost_overlay · render_compare_prescriptions


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