FIX: adding kit_system_id info to forward solution #13520
+11
−1
Conversation
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
When raw.info contains a kit_system_id, the function make_forward_solution expects this value to be present during forward computation and raises an error if it is missing. Previously, the kit_system_id field was unintentionally dropped when constructing the Info object used for the forward solution, leading to this failure. This PR resolves the issue by preserving the kit_system_id field during Info creation. An explicit if check ensures that the field is added only when it is present in raw.info; if it is not present, no kit_system_id is included. This maintains consistency with the original metadata while avoiding unnecessary or incorrect fields.
|
Hello! 👋 Thanks for opening your first pull request here! ❤️ We will try to get back to you soon. 🚴 |
larsoner
reviewed
Dec 2, 2025
Member
larsoner
left a comment
larsoner
left a comment
There was a problem hiding this comment.
Seems reasonable to me!
Can you add a doc/changes/dev/13520.bugfix.rst using :newcontrib:? And also add some test that fails on main but passes on this PR? I'd expect something like
assert "kit_system_id" in fwd["info"]
would do it.
Comment on lines
499
to
500
| info = Info( | ||
| chs=info["chs"], |
Member
There was a problem hiding this comment.
To minimize diff and preserve blame how about
kwargs_fwd_info = dict(
...
)
then only a few lines change
Author
There was a problem hiding this comment.
Thank you so much for your comments, can you tell me where I should add the test?
Member
There was a problem hiding this comment.
Maybe in this test somewhere?
- Created .rst file - Added test in test_make_forward.py - Updated the changes made in _make_forward.py
for more information, see https://pre-commit.ci
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.
When working with KIT MEG systems, the
kit_system_idfield is an important piece of metadata associated with the recording setup. Previously, this field was lost during construction of theInfoobject used in the forward-solution pipeline, which made it unavailable in downstream contexts where it may be needed (e.g., during data conversion or when accessing KIT-specific metadata). This PR ensures thatkit_system_idis preserved whenever it is present inraw.info. An explicit if check adds the field only when it exists, so the behavior remains consistent for non-KIT datasets while maintaining important metadata for KIT recordings.