Improve description of structure Simd::ImageMatcher - #947
Merged
Conversation
Document ImageMatcher from real usage: Init/Create/Find/Add flow, filter-unique vs report-all-pairs patterns, Hash tag as source index, and the Hash64x64 / Empty() comment fixes. Co-authored-by: igor.ermolaev <igor.ermolaev@altezza.org>
ermig1979
marked this pull request as ready for review
September 4, 2026 15:04
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
Improved Doxygen descriptions of structure
Simd::ImageMatcherinsrc/Simd/SimdImageMatcher.hppfrom real usage insrc/Use/UseImageMatcher.cpp(report all similar pairs) andsrc/Test/TestImageMatcher.cpp(filter unique images). Added the change to release 7.2.166 notes indocs/2026.html.The comments now describe:
Init→Create→Find→Addflow, withTagas a source index (size_t)Result::hash->taganddifference * 100)Initmatcher selection fromnumber,thresholdandnormalizedCreateconverting non-Gray8 to Gray8 and resizing withSimdResizeMethodAreaEmpty()meaning (true before Init) and theHash64x64size (was wrongly documented as 32x32)Skip()excluding a stored hash from later Find without removing itNo executable code was changed. The test suite was not run, as requested.
Files
src/Simd/SimdImageMatcher.hppdocs/2026.html(release 7.2.166)Updated ImageMatcher comments
Release 7.2.166 notes
To show artifacts inline, enable in settings.