Clarify dark_threshold semantics for IR users in config.ini#1108
Open
ds17f wants to merge 1 commit into
Open
Conversation
The previous comment ('the lower this setting is, the more dark frames
are ignored') was technically correct but caused systemic confusion
with IR-camera users β see boltgolt#418, boltgolt#725, and boltgolt#884 β who read 'lower
ignores more dark frames' as 'lower is better for dark rooms' and
ended up with a stricter threshold than the default.
Rewrite the comment to:
* Lead with what the value means (rejection threshold for percentage
of near-black pixels in the frame).
* State direction explicitly (higher = tolerates darker rooms).
* Note the default is calibrated for visible-light webcams and that
IR-only cameras typically need 80-95.
This is documentation only; default value, behavior, and computation
are unchanged.
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.
The
dark_thresholdconfig comment causes systemic confusion for IR-camera users. Five years of issues β #418, #725, #884, plus the enhancement request #727 β boil down to users readingas "lower is better for dark rooms," then ending up with an even stricter threshold than the default and login failing more often, not less.
The comment is technically correct (lower threshold = more frames marked as dark and skipped) but the natural-language ambiguity is hard to escape without first understanding the histogram-bucket math in
compare.py.What this PR changes
Documentation only. Rewrites the comment to:
The default value (60), the underlying computation, and runtime behavior are all unchanged.
Why this is worth merging