Repository navigation
docs: correct description of bg_off computation in BackgroundSparseMed - #59
Merged
paulmueller merged 2 commits intoNov 5, 2026
Merged
Conversation
…eMed` The docstring said that the offset is the median of a 20px wide slice. Since the offset correction was introduced (0.18.0), the code has computed the difference of the mean brightness of the top 20 pixel rows in the frame and in the background image. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #59 +/- ##
=======================================
Coverage 87.61% 87.61%
=======================================
Files 63 63
Lines 4369 4369
=======================================
Hits 3828 3828
Misses 541 541 ☔ View full report in Codecov by Harness. 🚀 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.
Found while documenting the API (#52).
The docstring of
offset_correction(class andcheck_user_kwargs) said the offset is computed from the median of a 20px wide slice. The code has computed the difference between the mean brightness of the top 20 pixel rows of the frame and of the background image since the offset correction was introduced in 15160c6 (0.18.0); the code comments also say mean. Since changing the code would changebg_off(and thus the results), I corrected the docstring instead.Impact / PPID: documentation only.
🤖 Generated with Claude Code