encircled_energy — OPTICS imaging op

• 数据种类:image2d → pairs

• 调用: import fullseye as fs; fs.ledger.encircled_energy(psf, pixel_pitch_um=1.0, samples=64, max_radius_um=None, centre='centroid')(要直接调用实现,import optics; optics.encircled_energy(psf, pixel_pitch_um=1.0, samples=64, max_radius_um=None, centre='centroid');从台账取用则 opsoptics.get("encircled_energy"))

用法

点扩散函数(PSF)的环围能量:半径为 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*.

该族通用的输入契约(fail-closed)

optics 的每个算子都先校验输入再计算(不让任何东西无声通过):

• 单位写进参数名 —— _mm / _um / _deg / _mrad。把 mm 和 µm 弄混不会崩溃,而是给出「看着合理却是错的答案」,所以用命名来防。这里绝不从数值大小去猜单位。

• 字符串一律 ValueError —— float('50') 会成功,于是未解析的配置值会被当成长度混进来(实测:thin_lens('50', '200') 曾返回看着合理的 66.667 mm)。bool 也按 True == 1 的隐式提升拒绝。

• complex / masked array 一律 ValueError(仅接受实数槽位;拒绝无声丢弃虚部或剥掉掩码)。所有输入中的 NaN/Inf 一律 ValueError。

• 逐项点名拒绝除零及其近亲:焦距 0、曲率半径 0、折射率 <= 0、全不透明光阑(全为 0,归一化变成 0/0)、总和 <= 0 的 PSF、S0 = 0 的 Stokes 矢量、物体位于前焦点(像在无穷远)。

• 只有两个算子会返回非有限值,而且都写进了契约:depth_of_field 在超焦距以外返回 far_mm = inf(这正是超焦距的定义),gaussian_beam 在束腰处返回 wavefront_radius_mm = inf(平面波前的曲率半径)。两者都同时返回一个有限的搭档(far_is_infinite / curvature_per_mm)。除此之外的无声 NaN/Inf 都在内部检出并 ValueError ——「float64 溢出了」和「答案是无穷大」是两种不同的主张,不能拿后者的脸去交付前者。

• 尺寸上限:生成网格受 optics.MAX_GRID(4096)限制,传入的场/PSF/光阑受 optics.MAX_FIELD_ELEMENTS(2^24),ABCD 元件序列受 optics.MAX_SYSTEM_ELEMENTS(1024),Zernike 受 MAX_ZERNIKE_TERMS(512)/ MAX_ZERNIKE_ORDER(40)/ MAX_ZERNIKE_BASIS(2^25)。以 fail-closed 堵住「小参数引发巨大内部分配」的路径(实测:n_max=40 × 4096² 需要 108 GB)。

• 物理上不可能的状态同样拒绝:偏振度 > 1 的 Stokes 矢量、负透过率、负强度、n-|m| 为奇数等非法 Zernike 指标。

详细使用指南

• optics_imaging 族使用指南

背景知识指南(该算子背后的物理与约定)

• measurement_uncertainty — 测量不确定度与校准知识 —— 为了能主张“测得准”

• mv_cameras — 工业相机厂商(与传感器的对应、线扫描 / TDI)

• virtual_machine_vision — 虚拟机器视觉 —— 梳理参数与对象模型

参考(示例数据、文献)

• 示例数据目录(下载 URL / 许可证) —— 2-D 用 skimage.data(BSD/公有领域)加合成图,3-D 给出真实数据源(Stanford/PDS 等)的下载 URL。

• 算子来历与参考文献 —— 该算子族所依据的研究/方法出处。

• 算法的正典(作者、年份)与用途见上面的族使用指南。

可运行的示例(实际调用该算子并已验证的样例)

• optical_design_metrics — py -3.11 examples/optical_design_metrics.py

• poc_zoom_configurations — py -3.11 examples/poc_zoom_configurations.py

类型可衔接的下一个算子(可接受 pairs 作为输入)

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 算子登记表。本条目由 tools/opdocs.py md 自动生成(请勿手工编辑)。*

© 2026 Kazufumi Furuse — Fullseye operator documentation. Licensed under Apache-2.0.