-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Expand file tree
/
Copy pathtest_load_image.py
More file actions
568 lines (475 loc) · 24.6 KB
/
test_load_image.py
File metadata and controls
568 lines (475 loc) · 24.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
# Copyright (c) MONAI Consortium
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import os
import shutil
import tempfile
import unittest
from pathlib import Path
from unittest.mock import patch
import nibabel as nib
import numpy as np
import torch
from parameterized import parameterized
from PIL import Image
from monai.apps import download_and_extract
from monai.data import NibabelReader, PydicomReader
from monai.data.meta_obj import set_track_meta
from monai.data.meta_tensor import MetaTensor
from monai.transforms import LoadImage
from monai.utils import OptionalImportError, optional_import
from tests.test_utils import SkipIfNoModule, assert_allclose, skip_if_downloading_fails, testing_data_config
itk, has_itk = optional_import("itk", allow_namespace_pkg=True)
ITKReader, _ = optional_import("monai.data", name="ITKReader", as_type="decorator")
itk_uc, _ = optional_import("itk", name="UC", allow_namespace_pkg=True)
class _MiniReader:
"""a test case customised reader"""
def __init__(self, is_compatible=False):
self.is_compatible = is_compatible
def verify_suffix(self, _name):
return self.is_compatible
def read(self, name):
return name
def get_data(self, _obj):
return np.zeros((1, 1, 1)), {"name": "my test"}
TEST_CASE_1 = [{}, ["test_image.nii.gz"], (128, 128, 128)]
TEST_CASE_2 = [{}, ["test_image.nii.gz"], (128, 128, 128)]
TEST_CASE_3 = [{}, ["test_image.nii.gz", "test_image2.nii.gz", "test_image3.nii.gz"], (3, 128, 128, 128)]
TEST_CASE_3_1 = [ # .mgz format
{"reader": "nibabelreader"},
["test_image.mgz", "test_image2.mgz", "test_image3.mgz"],
(3, 128, 128, 128),
]
TEST_CASE_4 = [{}, ["test_image.nii.gz", "test_image2.nii.gz", "test_image3.nii.gz"], (3, 128, 128, 128)]
TEST_CASE_4_1 = [ # additional parameter
{"mmap": False},
["test_image.nii.gz", "test_image2.nii.gz", "test_image3.nii.gz"],
(3, 128, 128, 128),
]
TEST_CASE_5 = [{"reader": NibabelReader(mmap=False)}, ["test_image.nii.gz"], (128, 128, 128)]
TEST_CASE_GPU_1 = [{"reader": "nibabelreader", "to_gpu": True}, ["test_image.nii.gz"], (128, 128, 128)]
TEST_CASE_GPU_2 = [{"reader": "nibabelreader", "to_gpu": True}, ["test_image.nii"], (128, 128, 128)]
TEST_CASE_GPU_3 = [
{"reader": "nibabelreader", "to_gpu": True},
["test_image.nii", "test_image2.nii", "test_image3.nii"],
(3, 128, 128, 128),
]
TEST_CASE_GPU_4 = [
{"reader": "nibabelreader", "to_gpu": True},
["test_image.nii.gz", "test_image2.nii.gz", "test_image3.nii.gz"],
(3, 128, 128, 128),
]
TEST_CASE_6 = [{"reader": ITKReader() if has_itk else "itkreader"}, ["test_image.nii.gz"], (128, 128, 128)]
TEST_CASE_7 = [{"reader": ITKReader() if has_itk else "itkreader"}, ["test_image.nii.gz"], (128, 128, 128)]
TEST_CASE_8 = [
{"reader": ITKReader() if has_itk else "itkreader"},
["test_image.nii.gz", "test_image2.nii.gz", "test_image3.nii.gz"],
(3, 128, 128, 128),
]
TEST_CASE_8_1 = [
{"reader": ITKReader(channel_dim=0) if has_itk else "itkreader"},
["test_image.nii.gz", "test_image2.nii.gz", "test_image3.nii.gz"],
(384, 128, 128),
]
TEST_CASE_9 = [
{"reader": ITKReader() if has_itk else "itkreader"},
["test_image.nii.gz", "test_image2.nii.gz", "test_image3.nii.gz"],
(3, 128, 128, 128),
]
TEST_CASE_10 = [
{"reader": ITKReader(pixel_type=itk_uc) if has_itk else "itkreader"},
"tests/testing_data/CT_DICOM",
(16, 16, 4),
(16, 16, 4),
]
TEST_CASE_11 = [{"reader": "ITKReader", "pixel_type": itk_uc}, "tests/testing_data/CT_DICOM", (16, 16, 4), (16, 16, 4)]
TEST_CASE_12 = [
{"reader": "ITKReader", "pixel_type": itk_uc, "reverse_indexing": True},
"tests/testing_data/CT_DICOM",
(16, 16, 4),
(4, 16, 16),
]
TEST_CASE_13 = [{"reader": "nibabelreader", "channel_dim": 0}, "test_image.nii.gz", (3, 128, 128, 128)]
TEST_CASE_14 = [
{"reader": "nibabelreader", "channel_dim": -1, "ensure_channel_first": True},
"test_image.nii.gz",
(128, 128, 128, 3),
]
TEST_CASE_15 = [{"reader": "nibabelreader", "channel_dim": 2}, "test_image.nii.gz", (128, 128, 3, 128)]
TEST_CASE_16 = [{"reader": "itkreader", "channel_dim": 0}, "test_image.nii.gz", (3, 128, 128, 128)]
TEST_CASE_17 = [{"reader": "monai.data.ITKReader", "channel_dim": -1}, "test_image.nii.gz", (128, 128, 128, 3)]
TEST_CASE_18 = [
{"reader": "ITKReader", "channel_dim": 2, "ensure_channel_first": True},
"test_image.nii.gz",
(128, 128, 3, 128),
]
# test same dicom data with PydicomReader
TEST_CASE_19 = [{"reader": PydicomReader()}, "tests/testing_data/CT_DICOM", (16, 16, 4), (16, 16, 4)]
TEST_CASE_20 = [
{"reader": "PydicomReader", "ensure_channel_first": True, "force": True},
"tests/testing_data/CT_DICOM",
(16, 16, 4),
(1, 16, 16, 4),
]
TEST_CASE_21 = [
{"reader": "PydicomReader", "affine_lps_to_ras": True, "defer_size": "2 MB", "force": True},
"tests/testing_data/CT_DICOM",
(16, 16, 4),
(16, 16, 4),
]
# test reader consistency between PydicomReader and ITKReader on dicom data
TEST_CASE_22 = ["tests/testing_data/CT_DICOM"]
# test pydicom gpu reader
TEST_CASE_GPU_5 = [{"reader": "PydicomReader", "to_gpu": True}, "tests/testing_data/CT_DICOM", (16, 16, 4), (16, 16, 4)]
TEST_CASE_GPU_6 = [
{"reader": "PydicomReader", "ensure_channel_first": True, "force": True, "to_gpu": True},
"tests/testing_data/CT_DICOM",
(16, 16, 4),
(1, 16, 16, 4),
]
TESTS_META = []
for track_meta in (False, True):
TESTS_META.append([{}, (128, 128, 128), track_meta])
TESTS_META.append([{"reader": "ITKReader", "fallback_only": False}, (128, 128, 128), track_meta])
@unittest.skipUnless(has_itk, "itk not installed")
class TestLoadImage(unittest.TestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
with skip_if_downloading_fails():
cls.tmpdir = tempfile.mkdtemp()
key = "DICOM_single"
url = testing_data_config("images", key, "url")
hash_type = testing_data_config("images", key, "hash_type")
hash_val = testing_data_config("images", key, "hash_val")
download_and_extract(
url=url, output_dir=cls.tmpdir, hash_val=hash_val, hash_type=hash_type, file_type="zip"
)
cls.data_dir = os.path.join(cls.tmpdir, "CT_DICOM_SINGLE")
@classmethod
def tearDownClass(cls):
shutil.rmtree(cls.tmpdir)
super().tearDownClass()
@parameterized.expand(
[TEST_CASE_1, TEST_CASE_2, TEST_CASE_3, TEST_CASE_3_1, TEST_CASE_4, TEST_CASE_4_1, TEST_CASE_5]
)
def test_nibabel_reader(self, input_param, filenames, expected_shape):
test_image = np.random.rand(128, 128, 128)
with tempfile.TemporaryDirectory() as tempdir:
for i, name in enumerate(filenames):
filenames[i] = os.path.join(tempdir, name)
nib.save(nib.Nifti1Image(test_image, np.eye(4)), filenames[i])
result = LoadImage(image_only=True, **input_param)(filenames)
ext = "".join(Path(name).suffixes)
self.assertEqual(result.meta["filename_or_obj"], os.path.join(tempdir, "test_image" + ext))
self.assertEqual(result.meta["space"], "RAS")
assert_allclose(result.affine, torch.eye(4))
self.assertTupleEqual(result.shape, expected_shape)
@SkipIfNoModule("nibabel")
@SkipIfNoModule("cupy")
@SkipIfNoModule("kvikio")
@parameterized.expand([TEST_CASE_GPU_1, TEST_CASE_GPU_2, TEST_CASE_GPU_3, TEST_CASE_GPU_4])
def test_nibabel_reader_gpu(self, input_param, filenames, expected_shape):
if torch.__version__.endswith("nv24.8"):
# related issue: https://github.com/Project-MONAI/MONAI/issues/8274
# for this version, use randint test case to avoid the issue
test_image = torch.randint(0, 256, (128, 128, 128), dtype=torch.uint8).numpy()
else:
test_image = np.random.rand(128, 128, 128)
with tempfile.TemporaryDirectory() as tempdir:
for i, name in enumerate(filenames):
filenames[i] = os.path.join(tempdir, name)
nib.save(nib.Nifti1Image(test_image, np.eye(4)), filenames[i])
result = LoadImage(image_only=True, **input_param)(filenames)
ext = "".join(Path(name).suffixes)
self.assertEqual(result.meta["filename_or_obj"], os.path.join(tempdir, "test_image" + ext))
self.assertEqual(result.meta["space"], "RAS")
assert_allclose(result.affine, torch.eye(4))
self.assertTupleEqual(result.shape, expected_shape)
# verify gpu and cpu loaded data are the same
input_param_cpu = input_param.copy()
input_param_cpu["to_gpu"] = False
result_cpu = LoadImage(image_only=True, **input_param_cpu)(filenames)
assert_allclose(result_cpu, result.cpu(), atol=1e-6)
@parameterized.expand([TEST_CASE_6, TEST_CASE_7, TEST_CASE_8, TEST_CASE_8_1, TEST_CASE_9])
def test_itk_reader(self, input_param, filenames, expected_shape):
test_image = torch.randint(0, 256, (128, 128, 128), dtype=torch.uint8).numpy()
print("Test image value range:", test_image.min(), test_image.max())
with tempfile.TemporaryDirectory() as tempdir:
for i, name in enumerate(filenames):
filenames[i] = os.path.join(tempdir, name)
nib.save(nib.Nifti1Image(test_image, np.eye(4)), filenames[i])
result = LoadImage(image_only=True, **input_param)(filenames)
ext = "".join(Path(name).suffixes)
self.assertEqual(result.meta["filename_or_obj"], os.path.join(tempdir, "test_image" + ext))
self.assertEqual(result.meta["space"], "RAS")
assert_allclose(result.affine, torch.eye(4))
self.assertTupleEqual(result.shape, expected_shape)
@parameterized.expand([TEST_CASE_10, TEST_CASE_11, TEST_CASE_12, TEST_CASE_19, TEST_CASE_20, TEST_CASE_21])
def test_itk_dicom_series_reader(self, input_param, filenames, expected_shape, expected_np_shape):
result = LoadImage(image_only=True, **input_param)(filenames)
self.assertEqual(result.meta["filename_or_obj"], f"{Path(filenames)}")
assert_allclose(
result.affine,
torch.tensor(
[
[-0.488281, 0.0, 0.0, 125.0],
[0.0, -0.488281, 0.0, 128.100006],
[0.0, 0.0, 68.33333333, -99.480003],
[0.0, 0.0, 0.0, 1.0],
]
),
)
self.assertTupleEqual(result.shape, expected_np_shape)
@SkipIfNoModule("pydicom")
@SkipIfNoModule("cupy")
@SkipIfNoModule("kvikio")
@parameterized.expand([TEST_CASE_GPU_5, TEST_CASE_GPU_6])
def test_pydicom_gpu_reader(self, input_param, filenames, expected_shape, expected_np_shape):
result = LoadImage(image_only=True, **input_param)(filenames)
self.assertEqual(result.meta["filename_or_obj"], f"{Path(filenames)}")
assert_allclose(
result.affine,
torch.tensor(
[
[-0.488281, 0.0, 0.0, 125.0],
[0.0, -0.488281, 0.0, 128.100006],
[0.0, 0.0, 68.33333333, -99.480003],
[0.0, 0.0, 0.0, 1.0],
]
),
)
self.assertTupleEqual(result.shape, expected_np_shape)
def test_no_files(self):
with self.assertRaisesRegex(RuntimeError, "list index out of range"): # fname_regex excludes everything
LoadImage(image_only=True, reader="PydicomReader", fname_regex=r"^(?!.*).*")("tests/testing_data/CT_DICOM")
LoadImage(image_only=True, reader="PydicomReader", fname_regex=None)("tests/testing_data/CT_DICOM")
def test_itk_dicom_series_reader_single(self):
result = LoadImage(image_only=True, reader="ITKReader")(self.data_dir)
self.assertEqual(result.meta["filename_or_obj"], f"{Path(self.data_dir)}")
assert_allclose(
result.affine,
torch.tensor(
[
[-0.488281, 0.0, 0.0, 125.0],
[0.0, -0.488281, 0.0, 128.100006],
[0.0, 0.0, 1.0, -99.480003],
[0.0, 0.0, 0.0, 1.0],
]
),
)
self.assertTupleEqual(result.shape, (16, 16, 1))
def test_itk_reader_multichannel(self):
test_image = np.random.randint(0, 256, size=(256, 224, 3)).astype("uint8")
with tempfile.TemporaryDirectory() as tempdir:
filename = os.path.join(tempdir, "test_image.png")
itk_np_view = itk.image_view_from_array(test_image, is_vector=True)
itk.imwrite(itk_np_view, filename)
for flag in (False, True):
result = LoadImage(image_only=True, reader=ITKReader(reverse_indexing=flag))(Path(filename))
test_image = test_image.transpose(1, 0, 2)
np.testing.assert_allclose(result[:, :, 0], test_image[:, :, 0])
np.testing.assert_allclose(result[:, :, 1], test_image[:, :, 1])
np.testing.assert_allclose(result[:, :, 2], test_image[:, :, 2])
@parameterized.expand([TEST_CASE_22])
def test_dicom_reader_consistency(self, filenames):
itk_param = {"reader": "ITKReader"}
pydicom_param = {"reader": "PydicomReader"}
for affine_flag in [True, False]:
itk_param["affine_lps_to_ras"] = affine_flag
pydicom_param["affine_lps_to_ras"] = affine_flag
itk_result = LoadImage(image_only=True, **itk_param)(filenames)
pydicom_result = LoadImage(image_only=True, **pydicom_param)(filenames)
np.testing.assert_allclose(pydicom_result, itk_result)
np.testing.assert_allclose(pydicom_result.affine, itk_result.affine)
@SkipIfNoModule("pydicom")
@SkipIfNoModule("cupy")
@SkipIfNoModule("kvikio")
@parameterized.expand([TEST_CASE_22])
def test_pydicom_reader_gpu_cpu_consistency(self, filenames):
gpu_param = {"reader": "PydicomReader", "to_gpu": True}
cpu_param = {"reader": "PydicomReader", "to_gpu": False}
for affine_flag in [True, False]:
gpu_param["affine_lps_to_ras"] = affine_flag
cpu_param["affine_lps_to_ras"] = affine_flag
gpu_result = LoadImage(image_only=True, **gpu_param)(filenames)
cpu_result = LoadImage(image_only=True, **cpu_param)(filenames)
np.testing.assert_allclose(gpu_result.cpu(), cpu_result)
np.testing.assert_allclose(gpu_result.affine.cpu(), cpu_result.affine)
def test_dicom_reader_consistency_single(self):
itk_param = {"reader": "ITKReader"}
pydicom_param = {"reader": "PydicomReader"}
for affine_flag in [True, False]:
itk_param["affine_lps_to_ras"] = affine_flag
pydicom_param["affine_lps_to_ras"] = affine_flag
itk_result = LoadImage(image_only=True, **itk_param)(self.data_dir)
pydicom_result = LoadImage(image_only=True, **pydicom_param)(self.data_dir)
np.testing.assert_allclose(pydicom_result, itk_result.squeeze())
np.testing.assert_allclose(pydicom_result.affine, itk_result.affine)
def test_load_nifti_multichannel(self):
test_image = np.random.randint(0, 256, size=(31, 64, 16, 2)).astype(np.float32)
with tempfile.TemporaryDirectory() as tempdir:
filename = os.path.join(tempdir, "test_image.nii.gz")
itk_np_view = itk.image_view_from_array(test_image, is_vector=True)
itk.imwrite(itk_np_view, filename)
itk_img = LoadImage(image_only=True, reader=ITKReader())(Path(filename))
self.assertTupleEqual(tuple(itk_img.shape), (16, 64, 31, 2))
nib_image = LoadImage(image_only=True, reader=NibabelReader(squeeze_non_spatial_dims=True))(Path(filename))
self.assertTupleEqual(tuple(nib_image.shape), (16, 64, 31, 2))
np.testing.assert_allclose(itk_img, nib_image, atol=1e-3, rtol=1e-3)
def test_load_png(self):
spatial_size = (256, 224)
test_image = np.random.randint(0, 256, size=spatial_size)
with tempfile.TemporaryDirectory() as tempdir:
filename = os.path.join(tempdir, "test_image.png")
Image.fromarray(test_image.astype("uint8")).save(filename)
result = LoadImage(image_only=True)(filename)
self.assertTupleEqual(result.shape, spatial_size[::-1])
np.testing.assert_allclose(result.T, test_image)
def test_register(self):
spatial_size = (32, 64, 128)
test_image = np.random.rand(*spatial_size)
with tempfile.TemporaryDirectory() as tempdir:
filename = os.path.join(tempdir, "test_image.nii.gz")
itk_np_view = itk.image_view_from_array(test_image)
itk.imwrite(itk_np_view, filename)
loader = LoadImage(image_only=True)
loader.register(ITKReader())
result = loader(filename)
self.assertTupleEqual(result.shape, spatial_size[::-1])
def test_kwargs(self):
spatial_size = (32, 64, 128)
test_image = np.random.rand(*spatial_size)
with tempfile.TemporaryDirectory() as tempdir:
filename = os.path.join(tempdir, "test_image.nii.gz")
itk_np_view = itk.image_view_from_array(test_image)
itk.imwrite(itk_np_view, filename)
loader = LoadImage(image_only=True)
reader = ITKReader(fallback_only=False)
loader.register(reader)
result = loader(filename)
reader = ITKReader()
img = reader.read(filename, fallback_only=False)
result_raw = reader.get_data(img)
result_raw = MetaTensor.ensure_torch_and_prune_meta(*result_raw)
self.assertTupleEqual(result.shape, result_raw.shape)
def test_my_reader(self):
"""test customised readers"""
out = LoadImage(image_only=True, reader=_MiniReader, is_compatible=True)("test")
self.assertEqual(out.meta["name"], "my test")
out = LoadImage(image_only=True, reader=_MiniReader, is_compatible=False)("test")
self.assertEqual(out.meta["name"], "my test")
for item in (_MiniReader, _MiniReader(is_compatible=False)):
out = LoadImage(image_only=True, reader=item)("test")
self.assertEqual(out.meta["name"], "my test")
out = LoadImage(image_only=True)("test", reader=_MiniReader(is_compatible=False))
self.assertEqual(out.meta["name"], "my test")
def test_itk_meta(self):
"""test metadata from a directory"""
out = LoadImage(image_only=True, reader="ITKReader", pixel_type=itk_uc, series_meta=True)(
"tests/testing_data/CT_DICOM"
)
idx = "0008|103e"
label = itk.GDCMImageIO.GetLabelFromTag(idx, "")[1]
val = out.meta[idx]
expected = "Series Description=Routine Brain "
self.assertEqual(f"{label}={val}", expected)
@parameterized.expand([TEST_CASE_13, TEST_CASE_14, TEST_CASE_15, TEST_CASE_16, TEST_CASE_17, TEST_CASE_18])
def test_channel_dim(self, input_param, filename, expected_shape):
test_image = np.random.rand(*expected_shape)
with tempfile.TemporaryDirectory() as tempdir:
filename = os.path.join(tempdir, filename)
nib.save(nib.Nifti1Image(test_image, np.eye(4)), filename)
result = LoadImage(image_only=True, **input_param)(filename) # with itk, meta has 'qto_xyz': itkMatrixF44
self.assertTupleEqual(
result.shape, (3, 128, 128, 128) if input_param.get("ensure_channel_first", False) else expected_shape
)
self.assertEqual(result.meta["original_channel_dim"], input_param["channel_dim"])
@unittest.skipUnless(has_itk, "itk not installed")
class TestLoadImageMeta(unittest.TestCase):
@classmethod
def setUpClass(cls):
super().setUpClass()
cls.tmpdir = tempfile.mkdtemp()
test_image = nib.Nifti1Image(np.random.rand(128, 128, 128), np.eye(4))
nib.save(test_image, os.path.join(cls.tmpdir, "im.nii.gz"))
cls.test_data = os.path.join(cls.tmpdir, "im.nii.gz")
@classmethod
def tearDownClass(cls):
shutil.rmtree(cls.tmpdir)
super().tearDownClass()
@parameterized.expand(TESTS_META)
def test_correct(self, input_param, expected_shape, track_meta):
set_track_meta(track_meta)
r = LoadImage(image_only=True, prune_meta_pattern="glmax", prune_meta_sep="%", **input_param)(self.test_data)
self.assertTupleEqual(r.shape, expected_shape)
if track_meta:
self.assertIsInstance(r, MetaTensor)
self.assertTrue(hasattr(r, "affine"))
self.assertIsInstance(r.affine, torch.Tensor)
self.assertTrue("glmax" not in r.meta)
else:
self.assertIsInstance(r, torch.Tensor)
self.assertNotIsInstance(r, MetaTensor)
self.assertFalse(hasattr(r, "affine"))
class TestLoadImageMissingReader(unittest.TestCase):
"""Test that LoadImage raises RuntimeError when a user-specified reader is not installed."""
def test_explicit_reader_not_installed_raises_runtime_error(self):
"""When the user explicitly names a reader whose package is missing, a RuntimeError must be raised."""
# Patch the reader class so that instantiation raises OptionalImportError,
# simulating a missing optional dependency (e.g. itk not installed).
with patch("monai.data.ITKReader.__init__", side_effect=OptionalImportError("itk")):
with self.assertRaises(RuntimeError) as ctx:
LoadImage(reader="ITKReader")
self.assertIn("ITKReader", str(ctx.exception))
self.assertIn("not installed", str(ctx.exception))
def test_explicit_class_reader_not_installed_raises_runtime_error(self):
"""When user passes a class reader whose package is missing, RuntimeError is raised (not OptionalImportError)."""
# This tests the class path (not string path) to ensure consistent behavior
with patch("monai.data.ITKReader.__init__", side_effect=OptionalImportError("itk")):
with self.assertRaises(RuntimeError) as ctx:
LoadImage(reader=ITKReader)
self.assertIn("ITKReader", str(ctx.exception))
self.assertIn("not installed", str(ctx.exception))
def test_unspecified_reader_falls_back_silently(self):
"""When no reader is specified, missing optional readers should be silently skipped (no exception)."""
# Force the fallback path by simulating missing optional dependencies.
# Patch the constructor to raise OptionalImportError for some readers,
# then verify LoadImage still instantiates and logs warnings.
from monai.utils import OptionalImportError
# Patch SUPPORTED_READERS entries to raise OptionalImportError
# This simulates optional packages not being installed
from monai.transforms.io.array import SUPPORTED_READERS
# Patch a few readers to fail (e.g., ITKReader)
try:
original_itk = SUPPORTED_READERS.get("itk")
def failing_reader(*args, **kwargs):
raise OptionalImportError("itk not installed")
# Temporarily replace ITKReader with a failing version
SUPPORTED_READERS["itk"] = failing_reader
# Capture log output to verify warn-and-skip was invoked
with self.assertLogs("LoadImage", level="DEBUG") as cm:
loader = LoadImage()
self.assertIsInstance(loader, LoadImage)
# Verify we got the expected debug log about skipping the missing reader
self.assertTrue(any("not installed" in msg for msg in cm.output),
f"Expected 'not installed' in debug logs, got: {cm.output}")
finally:
# Restore original reader
if original_itk is not None:
SUPPORTED_READERS["itk"] = original_itk
def test_explicit_reader_available_succeeds(self):
"""When the user explicitly names a reader whose package IS installed, no exception is raised."""
# NibabelReader is always available (nibabel is a core dep)
loader = LoadImage(reader="NibabelReader")
self.assertIsInstance(loader, LoadImage)
if __name__ == "__main__":
unittest.main()