Rename vignetting transmission to illumination#159
Merged
Conversation
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 Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames the
optika.vignettingcalibration membertransmission→illumination.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.radiometryeffective-area model.illuminationis the distilled form of the standard "relative illumination" term.Renamed across:
AbstractInterpolatedVignettingModel.illumination(abstract property)PolynomialVignettingModel.illumination(field), and its use infit/plot/plot_residualTesting
pytest optika/vignetting/_vignetting_test.py— 26 passed; 100% coverage.black --checkandruff checkclean.🤖 Generated with Claude Code