Skip to content

Rename vignetting transmission to illumination#159

Merged
roytsmart merged 1 commit into
mainfrom
feature/vignetting-illumination
Jun 1, 2026
Merged

Rename vignetting transmission to illumination#159
roytsmart merged 1 commit into
mainfrom
feature/vignetting-illumination

Conversation

@roytsmart
Copy link
Copy Markdown
Collaborator

Summary

Renames the optika.vignetting calibration member transmissionillumination.

The vignetting model represents the relative spatial response of the system, normalized to one at the center of the field of view. So transmission — which reads as an absolute transmitted fraction — was misleading now that absolute optical throughput lives in the (forthcoming) optika.radiometry effective-area model. illumination is the distilled form of the standard "relative illumination" term.

Renamed across:

  • AbstractInterpolatedVignettingModel.illumination (abstract property)
  • PolynomialVignettingModel.illumination (field), and its use in fit/plot/plot_residual
  • the class docstrings, the example, and the tests

Testing

  • pytest optika/vignetting/_vignetting_test.py — 26 passed; 100% coverage.
  • black --check and ruff check clean.

🤖 Generated with Claude Code

The vignetting model represents the *relative* spatial response normalized to
one at the center of the field of view, so `transmission` (which reads as an
absolute transmitted fraction) was misleading. Rename the calibration
member to `illumination` (relative illumination) across the abstract property,
the `PolynomialVignettingModel` field, the fit/plot/plot_residual usages, the
example, and the tests.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.31%. Comparing base (c3d1e62) to head (a82b66d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #159   +/-   ##
=======================================
  Coverage   99.31%   99.31%           
=======================================
  Files         114      114           
  Lines        5722     5722           
=======================================
  Hits         5683     5683           
  Misses         39       39           
Flag Coverage Δ
unittests 99.31% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@roytsmart roytsmart merged commit 19191f3 into main Jun 1, 2026
12 checks passed
@roytsmart roytsmart deleted the feature/vignetting-illumination branch June 1, 2026 03:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant