imaging op• Data kinds: image2d → pairs
• Call: import fullseye as fs; fs.ledger.encircled_energy(psf, pixel_pitch_um=1.0, samples=64, max_radius_um=None, centre='centroid') (to call the implementation directly, import optics; optics.encircled_energy(psf, pixel_pitch_um=1.0, samples=64, max_radius_um=None, centre='centroid'); from the registry, opsoptics.get("encircled_energy"))
Encircled energy of a point-spread function: the fraction of the energy inside a circle of radius r.
The standard spot-quality curve of lens design (how much light lands inside a given pixel or fibre core). *psf* is an image2d of non-negative samples on a grid of *pixel_pitch_um* (use the pixel_pitch_um argument of lensimage.psf_from_opd, or the fine-grid spacing of pupil_psf); the circle is centred on the energy centroid by default (*centre* = 'centroid', 'peak', 'fft' for the fftshift origin, or a (row, col) pair in pixels). Edge pixels are weighted by the exact area inside the circle, so the curve is smooth in r; a radius under about two pixels is resolved only coarsely.
Returns a (samples, 2) float64 pairs array: column 0 the radius in micrometres from 0 to *max_radius_um* (default the largest circle that fits in the array about the centre), column 1 the fraction of the array's energy inside, in [0, 1], non-decreasing. Energy outside the array is not known, so a PSF window that cuts the wings off reads high; keep the window several times the spot.
Ground truth it reproduces: an unaberrated circular pupil gives the Airy pattern, whose encircled energy is 1 - J0(v)^2 - J1(v)^2 with v = 2 pi r / (lambda N): 83.8 % at the first dark ring (r = 1.2197 lambda N, Born and Wolf), 91.0 % at the second, 93.8 % at the third (measured in tests/test_optdesign_psf_metrics.py).
Raises ValueError: *psf* not 2-D / smaller than 3x3 / negative / zero energy / non-finite; non-positive *pixel_pitch_um* or *max_radius_um*; *samples* outside [2, 4096]; a radius that leaves the array; a bad *centre*.
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.
• measurement_uncertainty — Measurement uncertainty and calibration — what it takes to claim you are measuring
• mv_cameras — Industrial camera makers (sensor mapping, line scan / TDI)
• virtual_machine_vision — Virtual machine vision — enumerating the parameters and an object model
• 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
• poc_zoom_configurations — py -3.11 examples/poc_zoom_configurations.py
pairs as input)mtf50 · energy_to_photons · spectral_product · spectral_integral · spectral_stats · kubelka_munk_reflectance · hyperspectral_capture · film_thickness_fft
imaging)psf_to_mtf · mtf_diffraction · ensquared_energy · energy_radii · mtf_tangential_sagittal · wavefront_stats · edge_spread · sfr_from_edge
*Provenance: optics.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.