ENH: Wrap ObjectToObjectMultiMetricv4 for Python (issue #5652, supersedes #5653)#6227
Merged
hjmjohnson merged 2 commits intoInsightSoftwareConsortium:mainfrom May 9, 2026
Conversation
github-actions
Bot
added
type:Infrastructure
Member
Author
This comment was marked as resolved.
This comment was marked as resolved.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
hjmjohnson
force-pushed
the
wrap-multimetricv4-with-3arg-canonical
branch
from
2b5ede0 to
9988de2
Compare
Wrap itk::ObjectToObjectMultiMetricv4 with explicit TVirtualImage so AddMetric() resolves unambiguously. Each ImageToImageMetricv4 wrap now registers both the canonical 3-arg key and a 2-arg alias (same SWIG class) so existing user code keeps working. Supersedes InsightSoftwareConsortium#3909 / InsightSoftwareConsortium#5653. Co-Authored-By: Jon Haitz Legarreta Gorroño <jhlegarreta@users.noreply.github.com>
SWIG can't auto-upcast across POINTER_WITH_2_SUPERCLASSES. Helper introspects the metric's wrapped template params and casts through the canonical ImageToImageMetricv4 _Superclass typedef so callers don't have to spell it out.
hjmjohnson
force-pushed
the
wrap-multimetricv4-with-3arg-canonical
branch
from
9988de2 to
ddf2710
Compare
hjmjohnson
merged commit fbe52c0
into
InsightSoftwareConsortium:main
22 of 23 checks passed
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.
Wrap
itk::ObjectToObjectMultiMetricv4for Python. Supersedes #5653 — preserves every historical 2-arg template key forImageToImageMetricv4and its 6 derived classes (which #5653 silently broke).Why a new PR rather than rebasing #5653
#5653 switched 7
*ImageToImageMetricv4wraps from 2-arg (F2F2) to 3-arg (F2F2IF2) keys, silently breaking pre-existing user code (ImageRegistration{3,4,5}.py,ModifiedTime.py) and turning CI red on CDash + ARMBUILD-Python + ITK.{Linux,macOS}.Python.This PR registers BOTH keys: canonical 3-arg + 2-arg alias resolving to the same SWIG class via two
add_python_config_template()entries.itkTemplate.__add__keys on the template-arg string and parameter tuple, so duplicate-registration warnings don't fire. No wrap-generator core changes.Commits
ENH:Add Python wrapping for ObjectToObjectMultiMetricv4 (author: @thewtex) — newitkObjectToObjectMultiMetricv4.wrapfor(F,2),(F,3),(D,2),(D,3); 7 metric wrap files extended with the canonical-3-arg + 2-arg-alias pattern; newitkObjectToObjectMultiMetricv4Test.py.ENH:Additk.as_metric_basehelper forAddMetricupcasts — SWIG can't auto-upcast acrossPOINTER_WITH_2_SUPERCLASSES, so callers need an explicit upcast through the_Superclasstypedef. Helper introspects template params and does it.Local validation
pre-commit run --all-filescleanctest -R 'Metricv4Python|ImageToImageMetric|ModifiedTime'(no regressions)itkObjectToObjectMultiMetricv4PythonTestexercises both 2-arg and 3-arg keys +AddMetricfor MeanSquares, Mattes, mixedFixes: #5652