Fix #8442: pass meta_data to EnsureChannelFirst when track_meta is False

[williams145]

Fixes #8442

Description

LoadImage with ensure_channel_first=True raises ValueError when set_track_meta(False) is active.

Root cause chain:

1. set_track_meta(False) causes MetaTensor.ensure_torch_and_prune_meta() to return a plain tensor instead of a MetaTensor
2. EnsureChannelFirst()(img) then has no metadata source (img is not a MetaTensor and no meta_dict is passed)
3. This hits the ValueError branch in EnsureChannelFirst.__call__ at line 205 of utility/array.py

Fix: pass meta_data explicitly to EnsureChannelFirst when img is not a MetaTensor. EnsureChannelFirst.__call__ already accepts a meta_dict parameter; meta_data is always a validated dict at this point in LoadImage.__call__.

Types of changes

• Non-breaking change (fix or new feature that would not break existing functionality).
• Breaking change (fix or new feature that would cause existing functionality to change).
• New tests added to cover the changes.
• Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
• In-line docstrings updated.
• Documentation updated, tested make html command in the docs/ folder.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8c06832a-bae6-406d-ab2a-35d75ea14fe5

📥 Commits

Reviewing files that changed from the base of the PR and between 7d2bea2 and 045363d.

📒 Files selected for processing (2)

• monai/transforms/io/array.py
• tests/transforms/test_load_image.py

🚧 Files skipped from review as they are similar to previous changes (1)

• monai/transforms/io/array.py

---

📝 Walkthrough

Walkthrough

LoadImage.call now passes the loaded image metadata to EnsureChannelFirst by calling EnsureChannelFirst()(img, meta_dict=meta_data) when ensure_channel_first=True. Tests were updated to import get_track_meta, and a new test (test_track_meta_false_ensure_channel_first) temporarily disables global metadata tracking, runs LoadImage(image_only=True, ensure_channel_first=True) on a prepared NIfTI, asserts the output is a plain torch.Tensor with shape (1, 128, 128, 128), and restores the previous tracking state.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	Title clearly summarizes the main fix: passing metadata to EnsureChannelFirst when track_meta is False, addressing issue #8442.
Description check	✅ Passed	Description covers the bug, root cause chain, fix approach, and testing status. Required checklist items are marked appropriately.
Linked Issues check	✅ Passed	PR fully addresses #8442: passes metadata to EnsureChannelFirst when img is not a MetaTensor, preventing ValueError when set_track_meta(False) is active.
Out of Scope Changes check	✅ Passed	Changes are focused on the fix: modified LoadImage.call to pass meta_data to EnsureChannelFirst, and added a regression test covering the bug scenario.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@monai/transforms/io/array.py`:
- Around line 302-306: Add a regression test that verifies disabling meta
tracking with set_track_meta(False) does not break channel-first conversion when
using LoadImage or LoadImaged with ensure_channel_first=True: create a test that
calls set_track_meta(False), runs LoadImage(..., ensure_channel_first=True) (and
a LoadImaged variant) on a sample array, and asserts the output is channel-first
(shape/order) and that no MetaTensor metadata is attached (or meta dict remains
absent) to ensure EnsureChannelFirst still runs on plain tensors; reference
EnsureChannelFirst, LoadImage/LoadImaged, ensure_channel_first, set_track_meta,
and MetaTensor when locating code to test.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 9e5bb3f7-9f63-4fb0-9f3b-14fdd624423e

📥 Commits

Reviewing files that changed from the base of the PR and between 851054c and 797cdb7.

📒 Files selected for processing (1)

• monai/transforms/io/array.py

[williams145]

@ericspod: CI is green and the branch is up to date. Happy to answer any questions if helpful.

[ericspod]

Hi @williams145 thanks for this fix. I think it's correct but we should have a regression test for the class as suggested. I suggested a change, please have a look at that as well.

[williams145]

Thanks for the review. Verified the simplification works. Looking at EnsureChannelFirst.__call__, when img is a MetaTensor it does meta_dict = img.meta (line 212 of monai/transforms/utility/array.py), which overrides whatever was passed in. So passing meta_data unconditionally is safe in both cases. Applied your suggestion and pushed.

Also added a regression test (test_track_meta_false_ensure_channel_first) in tests/transforms/test_load_image.py that covers the exact scenario this PR fixes: set_track_meta(False) combined with ensure_channel_first=True. It asserts the result is a plain torch.Tensor (not MetaTensor) with the channel dim correctly added.

CI re-running now.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@tests/transforms/test_load_image.py`:
- Around line 500-508: The test hard-codes set_track_meta(True) in the finally
block which can clobber the suite's prior state; change the test
(test_track_meta_false_ensure_channel_first) to capture the current state at the
start (e.g., prev = get_track_meta()), call set_track_meta(False) for the test,
and then in the finally block restore the original with set_track_meta(prev)
instead of set_track_meta(True); keep using LoadImage(...) and the same
assertions and ensure get_track_meta/set_track_meta symbols are used to locate
the change.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: aff8f650-076c-4360-8760-9219eba1c8d4

📥 Commits

Reviewing files that changed from the base of the PR and between 797cdb7 and 36ded05.

📒 Files selected for processing (2)

• monai/transforms/io/array.py
• tests/transforms/test_load_image.py

[williams145]

Thanks for the suggestion; applied and pushed. Captured the previous state via get_track_meta() and restored it in the finally block so the test won't clobber whatever the suite had set before.