Repository navigation
Improve documentation for composite transform. - #2628
Merged
Merged
Conversation
blowekamp
approved these changes
Jul 14, 2026
blowekamp
left a comment
blowekamp
left a comment
Member
There was a problem hiding this comment.
Looks concise and clear to me.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the SimpleITK fundamentals documentation to clarify CompositeTransform ordering semantics and to help users translate transform ordering expectations when moving between SimpleITK and the ANTs toolchain.
Changes:
- Expanded the composite transform documentation with clearer “first added, last applied” examples.
- Added an ANTs-focused note describing the transform ordering relationship with
antsApplyTransforms. - Extended the workflow spellcheck dictionary with
Tn.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/source/fundamentalConcepts.rst | Clarifies composite transform stacking semantics and adds an ANTs ordering note with examples. |
| .github/workflows/additional_dictionary.txt | Adds Tn to the additional dictionary to avoid false positives in spellchecking. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Improve the documentation for the composite transform and add a note about how the order of transforms relates to the order used in the ANTs ecosystem. Co-authored-by: Soumya Snigdha Kundu <[email protected]>
Contributor
|
I'm happy with this. |
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.
Improve the documentation for the composite transform and add a note about how the order of transforms
relates to the order used in the ANTs ecosystem.