Repository navigation
Document filter test image comparison and baseline data workflow - #2643
Merged
Merged
Conversation
Add two CONTRIBUTING.md subsections under Testing: - "Comparing filter test output" documents the YAML tests: schema (tag/inputs/tolerance/md5hash), how it is expanded into C++ gtest and wrapped-language CMake tests, and the sitk_add_test()/ sitkCompareDriver IMAGE_COMPARE/IMAGE_MD5_COMPARE/TRANSFORM_COMPARE arguments. - "Testing data and baseline images" documents missing-baseline auto-generation, the numbered-suffix convention for multiple valid baselines, ExternalData-backed storage, and the sitk-upload-binary-data skill for uploading new/updated data. Add 'cp' and 'newbaseline' to the comment-spell-check dictionary.
blowekamp
force-pushed
the
docs/testing-baseline-images
branch
from
July 20, 2026 14:15
ba11c1f to
75ff760
Compare
blowekamp
marked this pull request as ready for review
July 20, 2026 14:15
dave3d
approved these changes
Jul 20, 2026
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
2 participants
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.
Adds two subsections to CONTRIBUTING.md under Testing, aimed at contributors adding or updating filter tests.
Changes
tests:schema (tag/inputs/tolerance/md5hash), how it's expanded by jinja templates into C++ gtest tests vs. wrapped-language (Lua/Ruby/R/Java/Tcl/C#) CMake tests, and thesitk_add_test()/sitkCompareDriverIMAGE_COMPARE/IMAGE_MD5_COMPARE/TRANSFORM_COMPAREarguments.cpcommand it prints to accept it), the numeric-suffix convention for multiple valid baselines,ExternalData-backed storage of baselines as.sha512content links, and thesitk-upload-binary-dataskill for uploading new/updated data.cpandnewbaselineto.github/workflows/additional_dictionary.txt(comment-spell-check dictionary) and rewords one sentence to avoid a false positive on "prepends".Testing
Testing/Unit/TestBase/sitkImageCompare.cxx,sitkCompareDriver.cxx,Testing/Unit/sitkImageFilterTestTemplate.cxx.jinja,Testing/Unit/ImageFilterCTestTemplate.cmake.jinja,CMake/sitkAddTest.cmake,CMake/sitkExternalData.cmake,ExpandTemplateGenerator/simpleitk_filter_description.schema.json, and an example filter YAML (Code/BasicFilters/yaml/AdaptiveHistogramEqualizationImageFilter.yaml).comment-spell-check.