simind-python-connector 1.0.1__tar.gz → 2.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. {simind_python_connector-1.0.1/simind_python_connector.egg-info → simind_python_connector-2.0.0}/PKG-INFO +1 -1
  2. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/changelog.rst +52 -0
  3. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/conf.py +1 -1
  4. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/geometry.rst +5 -4
  5. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/pyproject.toml +1 -1
  6. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/__init__.py +1 -1
  7. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/backends/__init__.py +7 -0
  8. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/builders/acquisition_builder.py +77 -29
  9. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/builders/image_builder.py +18 -6
  10. simind_python_connector-2.0.0/simind_python_connector/connectors/__init__.py +43 -0
  11. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/connectors/_spacing.py +13 -7
  12. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/connectors/python_connector.py +114 -22
  13. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/connectors/pytomography_adaptor.py +5 -0
  14. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/connectors/sirf_adaptor.py +3 -0
  15. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/connectors/stir_adaptor.py +3 -0
  16. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/converters/attenuation.py +3 -1
  17. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/converters/simind_to_stir.py +12 -10
  18. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/core/config.py +208 -58
  19. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/core/executor.py +36 -7
  20. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/utils/import_helpers.py +4 -0
  21. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/utils/interfile_numpy.py +18 -8
  22. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/utils/interfile_parser.py +4 -2
  23. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/utils/simind_utils.py +50 -11
  24. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/utils/stir_utils.py +7 -2
  25. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0/simind_python_connector.egg-info}/PKG-INFO +1 -1
  26. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector.egg-info/SOURCES.txt +6 -0
  27. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_acquisition_builder_unit.py +77 -2
  28. simind_python_connector-2.0.0/tests/test_attenuation_utils.py +116 -0
  29. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_backends.py +78 -0
  30. simind_python_connector-2.0.0/tests/test_connector_backend_separation.py +118 -0
  31. simind_python_connector-2.0.0/tests/test_container_scripts.py +290 -0
  32. simind_python_connector-2.0.0/tests/test_dicom_builder.py +156 -0
  33. simind_python_connector-2.0.0/tests/test_executor.py +217 -0
  34. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_image_builder_unit.py +23 -0
  35. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_interfile_numpy.py +128 -4
  36. simind_python_connector-2.0.0/tests/test_legacy_surface_policy.py +20 -0
  37. simind_python_connector-2.0.0/tests/test_marker_policy.py +117 -0
  38. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_native_adaptors.py +108 -12
  39. simind_python_connector-2.0.0/tests/test_packaging_resources.py +113 -0
  40. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_python_connector.py +245 -0
  41. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_pytomography_adaptor.py +85 -0
  42. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_schneider_density.py +3 -0
  43. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_simind_to_stir_converter.py +41 -9
  44. simind_python_connector-2.0.0/tests/test_simulation_config.py +208 -0
  45. simind_python_connector-2.0.0/tests/test_utils_small.py +96 -0
  46. simind_python_connector-1.0.1/simind_python_connector/connectors/__init__.py +0 -24
  47. simind_python_connector-1.0.1/tests/test_connector_backend_separation.py +0 -42
  48. simind_python_connector-1.0.1/tests/test_marker_policy.py +0 -72
  49. simind_python_connector-1.0.1/tests/test_simulation_config.py +0 -89
  50. simind_python_connector-1.0.1/tests/test_utils_small.py +0 -53
  51. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/LICENSE +0 -0
  52. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/MANIFEST.in +0 -0
  53. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/README.md +0 -0
  54. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/api.rst +0 -0
  55. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/backends.rst +0 -0
  56. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/connector_modernization_plan.rst +0 -0
  57. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/contributing.rst +0 -0
  58. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/01_basic_simulation.py +0 -0
  59. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/02_runtime_switch_comparison.py +0 -0
  60. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/03_multi_window.py +0 -0
  61. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/04_custom_config.py +0 -0
  62. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/05_scattwin_vs_penetrate_comparison.py +0 -0
  63. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/06_schneider_density_conversion.py +0 -0
  64. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/07A_stir_adaptor_osem.py +0 -0
  65. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/07B_sirf_adaptor_osem.py +0 -0
  66. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/07C_pytomography_adaptor_osem.py +0 -0
  67. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/08A_stir_adaptor_from_dicom.py +0 -0
  68. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/08B_sirf_adaptor_from_dicom.py +0 -0
  69. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/08C_pytomography_adaptor_from_dicom.py +0 -0
  70. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples/_python_connector_helpers.py +0 -0
  71. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/examples.rst +0 -0
  72. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/index.rst +0 -0
  73. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/installation.rst +0 -0
  74. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/intro.rst +0 -0
  75. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/testing.rst +0 -0
  76. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/docs/usage.rst +0 -0
  77. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/01_basic_simulation.py +0 -0
  78. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/02_runtime_switch_comparison.py +0 -0
  79. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/03_multi_window.py +0 -0
  80. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/04_custom_config.py +0 -0
  81. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/05_scattwin_vs_penetrate_comparison.py +0 -0
  82. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/06_schneider_density_conversion.py +0 -0
  83. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/07A_stir_adaptor_osem.py +0 -0
  84. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/07B_sirf_adaptor_osem.py +0 -0
  85. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/07C_pytomography_adaptor_osem.py +0 -0
  86. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/08A_stir_adaptor_from_dicom.py +0 -0
  87. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/08B_sirf_adaptor_from_dicom.py +0 -0
  88. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/08C_pytomography_adaptor_from_dicom.py +0 -0
  89. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/examples/_python_connector_helpers.py +0 -0
  90. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/requirements-dev.txt +0 -0
  91. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/requirements.txt +0 -0
  92. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/setup.cfg +0 -0
  93. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/backends/base.py +0 -0
  94. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/backends/sirf_backend.py +0 -0
  95. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/backends/stir_backend.py +0 -0
  96. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/builders/__init__.py +0 -0
  97. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/configs/AnyScan.yaml +0 -0
  98. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/configs/Discovery670.yaml +0 -0
  99. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/configs/Example.yaml +0 -0
  100. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/configs/MLD001_SCAN0.yaml +0 -0
  101. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/configs/__init__.py +0 -0
  102. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/configs/input.smc +0 -0
  103. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/connectors/base.py +0 -0
  104. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/converters/__init__.py +0 -0
  105. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/converters/dicom_to_stir.py +0 -0
  106. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/core/__init__.py +0 -0
  107. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/core/types.py +0 -0
  108. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/data/Schneider2000.json +0 -0
  109. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/data/__init__.py +0 -0
  110. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/data/bone.atn +0 -0
  111. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/data/h2o.atn +0 -0
  112. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/utils/__init__.py +0 -0
  113. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/utils/backend_access.py +0 -0
  114. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/utils/io_utils.py +0 -0
  115. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector/utils/sirf_stir_utils.py +0 -0
  116. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector.egg-info/dependency_links.txt +0 -0
  117. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector.egg-info/requires.txt +0 -0
  118. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/simind_python_connector.egg-info/top_level.txt +0 -0
  119. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/__init__.py +0 -0
  120. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/conftest.py +0 -0
  121. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_arithmetic_operations.py +0 -0
  122. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_connectors_base.py +0 -0
  123. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_container_library_isolation.py +0 -0
  124. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_example_config_profile.py +0 -0
  125. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_examples_backend_separation.py +0 -0
  126. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_geometry_isolation_forward_projection.py +0 -0
  127. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_integration.py +0 -0
  128. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_interfile_parser.py +0 -0
  129. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_osem_geometry_diagnostics.py +0 -0
  130. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_package_identity.py +0 -0
  131. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_sirf_stir_utils.py +0 -0
  132. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_stir_utils_backend_choice_unit.py +0 -0
  133. {simind_python_connector-1.0.1 → simind_python_connector-2.0.0}/tests/test_utils.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: simind-python-connector
3
- Version: 1.0.1
3
+ Version: 2.0.0
4
4
  Summary: Python SIMIND Monte Carlo connector with STIR/SIRF/PyTomography adaptors
5
5
  Author-email: Sam Porter <sam.porter.18@ucl.ac.uk>, Rebecca Gillen <rebecca.gillen.18@ucl.ac.uk>, "Efstathios (Stahis) Varzakis" <efstathios.varzakis.22@ucl.ac.uk>
6
6
  Maintainer-email: Sam Porter <sam.porter.18@ucl.ac.uk>
@@ -7,6 +7,58 @@ All notable changes to this project are documented in this file.
7
7
 
8
8
  The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_, and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
9
9
 
10
+ 2.0.0 - 2026-10-09
11
+ ------------------
12
+
13
+ Breaking Changes
14
+ ~~~~~~~~~~~~~~~~
15
+
16
+ - ``STIRSPECTAcquisitionDataBuilder`` no longer flips projection data along the
17
+ last axis.
18
+ - Runtime-operator switches passed to ``run()`` apply to that run only. They
19
+ are no longer kept on the connector for later runs.
20
+ - Each run deletes earlier outputs that share the output prefix before SIMIND
21
+ starts.
22
+ - The STIR backend needs ``stirextra`` as well as ``stir``.
23
+ - STIR/SIRF adaptors take the z voxel spacing from a different axis (see
24
+ Fixed). Results change for anisotropic voxels.
25
+ - Invalid inputs now raise ``ValueError``: empty, non-finite or negative source
26
+ and attenuation maps, array shapes that do not match the header, and
27
+ ``output_prefix`` values that contain a path. Energy-window validation raises
28
+ ``ValueError`` instead of ``AssertionError``.
29
+
30
+ Fixed
31
+ ~~~~~
32
+
33
+ - The packaged ``configs/input.smc`` is now included in the wheel. SMC parsing
34
+ handles fixed-width fields and checks section counts.
35
+ - STIR/SIRF adaptors read the z voxel spacing from the correct axis:
36
+ ``voxel_sizes()`` is ``(z, y, x)``, and raw ``get_grid_spacing()`` is
37
+ ``(unused, z, y, x)``.
38
+ - Voxel-map dimension indices 76, 77, 78, 79, 81 and 82 are set correctly.
39
+ - The executor resolves ``SIMIND_BIN`` and accepts executable paths that
40
+ contain spaces. The connector no longer changes the process working directory.
41
+ - Runtime switches apply to one run only. Output prefixes cannot escape the
42
+ output directory. Stale outputs are removed, and ``.win``, ``.smi`` and
43
+ ``.dmi`` inputs are kept.
44
+ - Energy-window validation raises ``ValueError`` instead of failing an
45
+ ``assert``.
46
+ - The Interfile loader honours data offsets, strips quoted values and rejects
47
+ truncated or oversized payloads. The SIMIND-to-STIR converter keeps data-file
48
+ lines and applies the radius scale factor.
49
+ - Attenuation utilities handle the ``rho*1000`` selector and STIR ``#`` header
50
+ keys, and reject unknown attenuation types.
51
+ - Image and acquisition builders validate array shapes, split multi-energy data
52
+ deterministically and no longer flip images. The DICOM builder handles missing
53
+ timing information and 2D pixel data.
54
+ - Backend adaptors are imported lazily, so the core package imports without
55
+ STIR, SIRF or PyTomography.
56
+
57
+ Removed
58
+ ~~~~~~~
59
+
60
+ - The legacy ``scripts/simulation.py``.
61
+
10
62
  1.0.1 - 2026-04-16
11
63
  ------------------
12
64
 
@@ -13,7 +13,7 @@ sys.path.insert(0, os.path.abspath(".."))
13
13
  project = "simind-python-connector"
14
14
  copyright = f"{datetime.now().year}, Sam Porter, Efstathios Varzakis"
15
15
  author = "Sam Porter, Efstathios Varzakis"
16
- release = "1.0.1"
16
+ release = "2.0.0"
17
17
  for dist_name in ("simind-python-connector",):
18
18
  try:
19
19
  release = importlib_metadata.version(dist_name)
@@ -35,10 +35,11 @@ Units
35
35
  - STIR/SIRF image geometry is typically expressed in **mm**.
36
36
  - Connectors handle conversion internally via voxel-size settings (for example,
37
37
  runtime switch ``PX`` is set in cm for SIMIND).
38
- - STIR/SIRF adaptor voxel size extraction expects z-spacing in mm. It uses
39
- ``voxel_sizes()[2]`` when available, and falls back to ``get_grid_spacing()``
40
- using the last spatial element (index 3 for 4-element spacing, index 2 for
41
- 3-element spacing).
38
+ - STIR/SIRF adaptor voxel size extraction expects z-spacing in mm. Images
39
+ report ``voxel_sizes()`` as ``(z, y, x)``, so the **first** element is the z
40
+ spacing. Raw ``get_grid_spacing()`` sequences follow the STIR coordinate
41
+ layout ``(unused, z, y, x)`` and use index 1; coordinate objects with a
42
+ ``z`` accessor use that accessor directly.
42
43
 
43
44
  Example Configuration Guardrails
44
45
  --------------------------------
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "simind-python-connector"
7
- version = "1.0.1"
7
+ version = "2.0.0"
8
8
  description = "Python SIMIND Monte Carlo connector with STIR/SIRF/PyTomography adaptors"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.9"
@@ -14,7 +14,7 @@ for _dist_name in ("simind-python-connector", __name__):
14
14
  except _meta.PackageNotFoundError:
15
15
  continue
16
16
  else: # editable / source checkout
17
- __version__ = "1.0.1"
17
+ __version__ = "2.0.0"
18
18
 
19
19
 
20
20
  def __getattr__(name: str) -> Any:
@@ -19,6 +19,7 @@ Usage:
19
19
 
20
20
  import importlib
21
21
  import logging
22
+ import os
22
23
  from typing import TYPE_CHECKING, Any, Literal, Optional, Union
23
24
 
24
25
  from .base import AcquisitionDataInterface, ImageDataInterface
@@ -233,6 +234,9 @@ def create_image_data(
233
234
  if isinstance(filepath_or_object, ImageDataInterface):
234
235
  return filepath_or_object
235
236
 
237
+ if isinstance(filepath_or_object, os.PathLike):
238
+ filepath_or_object = os.fspath(filepath_or_object)
239
+
236
240
  backend_hint = detect_image_backend(filepath_or_object)
237
241
  if backend_hint is None:
238
242
  backend_hint = detect_backend_from_interface(filepath_or_object)
@@ -314,6 +318,9 @@ def create_acquisition_data(
314
318
  if isinstance(filepath_or_object, AcquisitionDataInterface):
315
319
  return filepath_or_object
316
320
 
321
+ if isinstance(filepath_or_object, os.PathLike):
322
+ filepath_or_object = os.fspath(filepath_or_object)
323
+
317
324
  backend_hint = detect_acquisition_backend(filepath_or_object)
318
325
  if backend_hint is None:
319
326
  backend_hint = detect_backend_from_interface(filepath_or_object)
@@ -97,6 +97,19 @@ class STIRSPECTAcquisitionDataBuilder:
97
97
  else:
98
98
  self.pixel_array = np.array(self.pixel_array, dtype=np.float32)
99
99
 
100
+ expected_shape = (
101
+ 1,
102
+ matrix_size_1,
103
+ num_projections,
104
+ matrix_size_2,
105
+ )
106
+ if self.pixel_array.shape != expected_shape:
107
+ raise ValueError(
108
+ f"pixel array shape {self.pixel_array.shape} does not match "
109
+ f"header dimensions {expected_shape} "
110
+ "(tof, bin, view, axial)"
111
+ )
112
+
100
113
  def _write(base_path: Path, cleanup: bool) -> AcquisitionData:
101
114
  header_path = base_path.with_suffix(".hs")
102
115
  raw_file_path = base_path.with_suffix(".s")
@@ -112,9 +125,8 @@ class STIRSPECTAcquisitionDataBuilder:
112
125
 
113
126
  acqdata = self._load_acquisition(str(header_path))
114
127
 
115
- flipped = np.flip(self.pixel_array, axis=-1)
116
128
  acqdata = acqdata.clone()
117
- acqdata.fill(flipped)
129
+ acqdata.fill(self.pixel_array)
118
130
  acqdata.write(str(header_path))
119
131
 
120
132
  if cleanup:
@@ -194,27 +206,50 @@ class STIRSPECTAcquisitionDataBuilder:
194
206
  acqdata = self.build(output_path=output_path_base)
195
207
  return [acqdata]
196
208
 
209
+ if self.pixel_array is None:
210
+ raise ValueError(
211
+ "build_multi_energy requires pixel_array to be set "
212
+ "(use update_header_from_dicom or set it directly)"
213
+ )
214
+
215
+ num_windows = len(self.energy_windows)
216
+ total_projections = int(self.header.get("!number of projections", 1))
217
+ if self.pixel_array.ndim != 4 or (
218
+ self.pixel_array.shape[2] != total_projections
219
+ ):
220
+ raise ValueError(
221
+ f"pixel array shape {self.pixel_array.shape} does not match "
222
+ f"declared {total_projections} projections"
223
+ )
224
+ if total_projections % num_windows != 0:
225
+ raise ValueError(
226
+ f"Number of projections ({total_projections}) must be divisible "
227
+ f"by the number of energy windows ({num_windows})"
228
+ )
229
+ projections_per_window = total_projections // num_windows
230
+
197
231
  # number of projections needs dividing by number of energy windows
198
- num_projections = int(self.header.get("!number of projections", 1))
199
- num_projections //= len(self.energy_windows)
200
- self.header["!number of projections"] = str(num_projections)
232
+ self.header["!number of projections"] = str(projections_per_window)
201
233
 
202
234
  # split pixel_array into energy windows along 3rd axis
203
- pixel_array_list = np.array_split(
204
- self.pixel_array, len(self.energy_windows), axis=2
205
- )
206
-
207
- acqdata_list = []
208
- for idx, ew in enumerate(self.energy_windows):
209
- # Update header for this energy window.
210
- self.header["energy window lower level[1]"] = ew["lower"]
211
- self.header["energy window upper level[1]"] = ew["upper"]
212
- suffix = f"_ew{idx + 1}"
213
- output_path = output_path_base + suffix
214
- self.pixel_array = pixel_array_list[idx]
215
- acqdata = self.build(output_path=output_path)
216
- acqdata_list.append(acqdata)
217
- return acqdata_list
235
+ original_pixel_array = self.pixel_array
236
+ try:
237
+ pixel_array_list = np.array_split(original_pixel_array, num_windows, axis=2)
238
+
239
+ acqdata_list = []
240
+ for idx, ew in enumerate(self.energy_windows):
241
+ # Update header for this energy window.
242
+ self.header["energy window lower level[1]"] = ew["lower"]
243
+ self.header["energy window upper level[1]"] = ew["upper"]
244
+ suffix = f"_ew{idx + 1}"
245
+ output_path = output_path_base + suffix
246
+ self.pixel_array = pixel_array_list[idx]
247
+ acqdata = self.build(output_path=output_path)
248
+ acqdata_list.append(acqdata)
249
+ return acqdata_list
250
+ finally:
251
+ self.pixel_array = original_pixel_array
252
+ self.header["!number of projections"] = str(total_projections)
218
253
 
219
254
  def update_header_from_dicom(self, dicom_filepath):
220
255
  """
@@ -303,6 +338,8 @@ class STIRSPECTAcquisitionDataBuilder:
303
338
  )
304
339
 
305
340
  # Rotation Information Sequence processing
341
+ num_frames = ds.get("NumberOfFrames", None)
342
+ time_per_projection = None
306
343
  try:
307
344
  if (0x0054, 0x0052) in ds:
308
345
  rot_seq = ds[(0x0054, 0x0052)].value
@@ -322,16 +359,17 @@ class STIRSPECTAcquisitionDataBuilder:
322
359
  rot_item[(0x0018, 0x1242)].value / 1000
323
360
  )
324
361
 
325
- if num_frames is not None:
362
+ if time_per_projection is not None and num_frames is not None:
326
363
  self.header["number of time frames"] = str(1)
327
364
  self.header["!image duration (sec)[1]"] = str(
328
365
  int(
329
366
  np.round(
330
- float(time_per_projection) * float(num_frames), 0
367
+ float(time_per_projection) * float(num_frames),
368
+ 0,
331
369
  )
332
370
  )
333
371
  )
334
- else:
372
+ elif time_per_projection is not None:
335
373
  self.header["!time per projection (sec)[1]"] = (
336
374
  time_per_projection
337
375
  )
@@ -516,11 +554,21 @@ class STIRSPECTAcquisitionDataBuilder:
516
554
  except AttributeError:
517
555
  warnings.warn("StudyDescription not found in DICOM.")
518
556
  try:
519
- self.pixel_array = ds.pixel_array
520
- print(self.pixel_array.shape)
521
- self.pixel_array = np.transpose(self.pixel_array, (2, 0, 1))
522
- # rotate the image by 90 degrees cW in axis 1
523
- self.pixel_array = np.rot90(self.pixel_array, 3, axes=(0, 2))
524
- self.pixel_array = np.expand_dims(self.pixel_array, axis=0)
557
+ raw_pixel_array = ds.pixel_array
525
558
  except AttributeError:
526
559
  warnings.warn("Pixel data not found in DICOM.")
560
+ return
561
+
562
+ raw_pixel_array = np.asarray(raw_pixel_array)
563
+ if raw_pixel_array.ndim == 2:
564
+ # Single frame: promote to (frames=1, rows, columns) so the
565
+ # transpose below sees the same layout as multiframe data.
566
+ raw_pixel_array = raw_pixel_array[np.newaxis, :, :]
567
+ elif raw_pixel_array.ndim != 3:
568
+ raise ValueError(
569
+ f"pixel data must be 2D or 3D, got {raw_pixel_array.ndim}D"
570
+ )
571
+ self.pixel_array = np.transpose(raw_pixel_array, (2, 0, 1))
572
+ # rotate the image by 90 degrees cW in axis 1
573
+ self.pixel_array = np.rot90(self.pixel_array, 3, axes=(0, 2))
574
+ self.pixel_array = np.expand_dims(self.pixel_array, axis=0)
@@ -79,12 +79,24 @@ class STIRSPECTImageDataBuilder:
79
79
 
80
80
  def _resolve_data_array(self) -> np.ndarray:
81
81
  if self.pixel_array is not None:
82
- return np.asarray(self.pixel_array, dtype=np.float32)
83
-
84
- dim_x = int(self.header["!matrix size [1]"])
85
- dim_y = int(self.header["!matrix size [2]"])
86
- dim_z = int(self.header["!matrix size [3]"])
87
- return np.zeros((dim_z, dim_y, dim_x), dtype=np.float32)
82
+ data = np.asarray(self.pixel_array, dtype=np.float32)
83
+ else:
84
+ dim_x = int(self.header["!matrix size [1]"])
85
+ dim_y = int(self.header["!matrix size [2]"])
86
+ dim_z = int(self.header["!matrix size [3]"])
87
+ data = np.zeros((dim_z, dim_y, dim_x), dtype=np.float32)
88
+
89
+ expected_shape = (
90
+ int(self.header["!matrix size [3]"]),
91
+ int(self.header["!matrix size [2]"]),
92
+ int(self.header["!matrix size [1]"]),
93
+ )
94
+ if data.shape != expected_shape:
95
+ raise ValueError(
96
+ f"pixel array shape {data.shape} does not match header "
97
+ f"dimensions {expected_shape} (z, y, x)"
98
+ )
99
+ return data
88
100
 
89
101
  def build(self, output_path: Optional[str | Path] = None):
90
102
  """
@@ -0,0 +1,43 @@
1
+ """Connector/adaptor APIs.
2
+
3
+ Backend-specific adaptors are exposed lazily so that importing this package
4
+ never imports SIRF, STIR, or PyTomography.
5
+ """
6
+
7
+ import importlib
8
+
9
+ from .base import BaseConnector
10
+ from .python_connector import (
11
+ NumpyConnector,
12
+ ProjectionResult,
13
+ RuntimeOperator,
14
+ SimindPythonConnector,
15
+ )
16
+
17
+
18
+ _LAZY_ADAPTORS = {
19
+ "PyTomographySimindAdaptor": "pytomography_adaptor",
20
+ "SirfSimindAdaptor": "sirf_adaptor",
21
+ "StirSimindAdaptor": "stir_adaptor",
22
+ }
23
+
24
+
25
+ def __getattr__(name):
26
+ if name in _LAZY_ADAPTORS:
27
+ module = importlib.import_module(f".{_LAZY_ADAPTORS[name]}", __name__)
28
+ obj = getattr(module, name)
29
+ globals()[name] = obj
30
+ return obj
31
+ raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
32
+
33
+
34
+ __all__ = [
35
+ "BaseConnector",
36
+ "NumpyConnector",
37
+ "PyTomographySimindAdaptor",
38
+ "ProjectionResult",
39
+ "RuntimeOperator",
40
+ "SirfSimindAdaptor",
41
+ "SimindPythonConnector",
42
+ "StirSimindAdaptor",
43
+ ]
@@ -17,9 +17,11 @@ def _voxel_size_from_spacing(spacing: Any) -> float | None:
17
17
 
18
18
  if values:
19
19
  if len(values) >= 4:
20
- return float(values[3])
21
- if len(values) >= 3:
22
- return float(values[2])
20
+ # Raw STIR-style coordinate sequence: (unused, z, y, x)
21
+ return float(values[1])
22
+ if len(values) == 3:
23
+ # Public (z, y, x) convention
24
+ return float(values[0])
23
25
 
24
26
  if hasattr(spacing, "z"):
25
27
  try:
@@ -28,13 +30,13 @@ def _voxel_size_from_spacing(spacing: Any) -> float | None:
28
30
  pass
29
31
 
30
32
  if hasattr(spacing, "at"):
31
- for index in (3, 2):
33
+ for index in (1, 2, 3):
32
34
  try:
33
35
  return float(spacing.at(index))
34
36
  except Exception:
35
37
  continue
36
38
 
37
- for index in (3, 2):
39
+ for index in (1, 2, 3):
38
40
  try:
39
41
  return float(spacing[index])
40
42
  except Exception:
@@ -44,12 +46,16 @@ def _voxel_size_from_spacing(spacing: Any) -> float | None:
44
46
 
45
47
 
46
48
  def extract_voxel_size_mm(image: Any, backend_name: str) -> float:
47
- """Extract z voxel spacing in mm from backend image metadata."""
49
+ """Extract z voxel spacing in mm from backend image metadata.
50
+
51
+ Backend images report ``voxel_sizes()`` in ``(z, y, x)`` order, so the
52
+ first element is the z spacing.
53
+ """
48
54
  if hasattr(image, "voxel_sizes"):
49
55
  voxel_sizes = image.voxel_sizes()
50
56
  try:
51
57
  if len(voxel_sizes) >= 3:
52
- return float(voxel_sizes[2])
58
+ return float(voxel_sizes[0])
53
59
  except Exception:
54
60
  pass
55
61
 
@@ -6,6 +6,7 @@ from __future__ import annotations
6
6
 
7
7
  import contextlib
8
8
  import logging
9
+ import math
9
10
  import os
10
11
  import shutil
11
12
  from dataclasses import dataclass, field
@@ -62,11 +63,12 @@ class SimindPythonConnector(BaseConnector):
62
63
  quantization_scale: float = 1.0,
63
64
  ) -> None:
64
65
  self.logger = logging.getLogger(__name__)
66
+ self._validate_output_prefix(output_prefix)
65
67
  self.output_dir = Path(output_dir).expanduser().resolve()
66
68
  self.output_dir.mkdir(parents=True, exist_ok=True)
67
69
  self.output_prefix = output_prefix
68
70
  self.quantization_scale = float(quantization_scale)
69
- if self.quantization_scale <= 0:
71
+ if not math.isfinite(self.quantization_scale) or self.quantization_scale <= 0:
70
72
  raise ValueError("quantization_scale must be > 0")
71
73
 
72
74
  self.config = self._initialize_config(config_source)
@@ -75,12 +77,31 @@ class SimindPythonConnector(BaseConnector):
75
77
  self.converter = SimindToStirConverter()
76
78
 
77
79
  self._outputs: Optional[dict[str, ProjectionResult]] = None
80
+ self._window_file_path: Optional[Path] = None
81
+
82
+ @staticmethod
83
+ def _validate_output_prefix(prefix: str) -> None:
84
+ """Reject prefixes that could escape the output directory."""
85
+ if (
86
+ not isinstance(prefix, str)
87
+ or not prefix
88
+ or prefix in {".", ".."}
89
+ or "/" in prefix
90
+ or "\\" in prefix
91
+ or Path(prefix).is_absolute()
92
+ ):
93
+ raise ValueError(f"output_prefix must be a plain filename, got {prefix!r}")
78
94
 
79
95
  @staticmethod
80
96
  def _initialize_config(config_source: ConfigSource) -> SimulationConfig:
81
97
  if isinstance(config_source, SimulationConfig):
82
98
  return config_source
83
99
 
100
+ if not isinstance(config_source, (str, os.PathLike)):
101
+ # importlib.resources Traversable from configs.get(): hand it to
102
+ # SimulationConfig untouched (supports zipped installs).
103
+ return SimulationConfig(config_source)
104
+
84
105
  config_path = Path(config_source).expanduser().resolve()
85
106
  if not config_path.exists():
86
107
  raise FileNotFoundError(f"Configuration file not found: {config_source}")
@@ -124,14 +145,30 @@ class SimindPythonConnector(BaseConnector):
124
145
  raise ValueError("source and mu_map must have identical shapes")
125
146
 
126
147
  vox_cm = float(voxel_size_mm) / SIMIND_VOXEL_UNIT_CONVERSION
127
- if vox_cm <= 0:
148
+ if not math.isfinite(vox_cm) or vox_cm <= 0:
128
149
  raise ValueError("voxel_size_mm must be > 0")
129
-
130
- routine = (
131
- ScoringRoutine(scoring_routine)
132
- if isinstance(scoring_routine, int)
133
- else scoring_routine
134
- )
150
+ if source_array.size == 0 or mu_map_array.size == 0:
151
+ raise ValueError("source and mu_map must not be empty")
152
+ if not np.isfinite(source_array).all() or not np.isfinite(mu_map_array).all():
153
+ raise ValueError("source and mu_map must contain only finite values")
154
+ if (source_array < 0).any() or (mu_map_array < 0).any():
155
+ raise ValueError("source and mu_map must be non-negative")
156
+
157
+ if isinstance(scoring_routine, ScoringRoutine):
158
+ routine = scoring_routine
159
+ elif isinstance(scoring_routine, int) and not isinstance(scoring_routine, bool):
160
+ try:
161
+ routine = ScoringRoutine(scoring_routine)
162
+ except ValueError as exc:
163
+ raise ValueError(
164
+ f"scoring_routine {scoring_routine!r} is not a valid "
165
+ "ScoringRoutine value"
166
+ ) from exc
167
+ else:
168
+ raise ValueError(
169
+ "scoring_routine must be a ScoringRoutine or int, got "
170
+ f"{type(scoring_routine).__name__}"
171
+ )
135
172
  dim_z, dim_y, dim_x = (int(v) for v in source_array.shape)
136
173
 
137
174
  cfg = self.config
@@ -156,8 +193,10 @@ class SimindPythonConnector(BaseConnector):
156
193
  cfg.set_value(31, vox_cm)
157
194
  cfg.set_value(33, 1)
158
195
  cfg.set_value(34, dim_z)
159
- cfg.set_value(78, dim_x)
160
- cfg.set_value(79, dim_y)
196
+ cfg.set_value(78, dim_x) # density map i
197
+ cfg.set_value(79, dim_x) # source map i
198
+ cfg.set_value(81, dim_y) # density map j
199
+ cfg.set_value(82, dim_y) # source map j
161
200
 
162
201
  self.runtime_switches.set_switch("PX", vox_cm)
163
202
 
@@ -198,12 +237,14 @@ class SimindPythonConnector(BaseConnector):
198
237
  scatter_orders: Union[int, list[int]],
199
238
  ) -> None:
200
239
  """Write a SIMIND window file for this connector run."""
240
+ window_path = self.output_dir / f"{self.output_prefix}.win"
201
241
  create_window_file(
202
242
  lower_bounds,
203
243
  upper_bounds,
204
244
  scatter_orders,
205
- output_filename=str(self.output_dir / self.output_prefix),
245
+ output_filename=str(window_path),
206
246
  )
247
+ self._window_file_path = window_path
207
248
 
208
249
  def run(
209
250
  self, runtime_operator: Optional[RuntimeOperator] = None
@@ -211,22 +252,27 @@ class SimindPythonConnector(BaseConnector):
211
252
  """Run SIMIND and return projection outputs as NumPy arrays."""
212
253
  self._outputs = None
213
254
 
255
+ # Runtime-operator switches apply to this run only; merge them into
256
+ # a throwaway switch set instead of persistent connector state.
257
+ run_switches_holder = RuntimeSwitches()
258
+ for key, value in self.runtime_switches.switches.items():
259
+ run_switches_holder.set_switch(key, value)
214
260
  orbit_file = None
215
261
  if runtime_operator is not None:
216
- self.set_runtime_switches(runtime_operator.switches)
262
+ for key, value in runtime_operator.switches.items():
263
+ run_switches_holder.set_switch(key, value)
217
264
  orbit_file = self._prepare_orbit_file(runtime_operator.orbit_file)
218
265
 
219
266
  config_path = self.output_dir / self.output_prefix
220
267
  self.config.save_file(config_path)
221
268
 
222
- original_cwd = Path.cwd()
223
- try:
224
- os.chdir(self.output_dir)
225
- self.executor.run_simulation(
226
- self.output_prefix, orbit_file, self.runtime_switches.switches
227
- )
228
- finally:
229
- os.chdir(original_cwd)
269
+ self._clear_previous_outputs()
270
+ self.executor.run_simulation(
271
+ self.output_prefix,
272
+ orbit_file,
273
+ run_switches_holder.switches,
274
+ cwd=self.output_dir,
275
+ )
230
276
 
231
277
  header_files = self._ensure_interfile_headers()
232
278
  self._outputs = self._load_projection_outputs(header_files)
@@ -241,6 +287,46 @@ class SimindPythonConnector(BaseConnector):
241
287
  def get_config(self) -> SimulationConfig:
242
288
  return self.config
243
289
 
290
+ _OUTPUT_SUFFIXES = {".h00", ".hs", ".a00", ".s", ".win"}
291
+
292
+ def _clear_previous_outputs(self) -> None:
293
+ """Delete stale outputs from earlier runs sharing this prefix.
294
+
295
+ Connector-written inputs (``{prefix}_src.smi`` / ``{prefix}_dns.dmi``)
296
+ are protected because SIMIND still needs them on disk.
297
+ """
298
+ protected = {
299
+ f"{self.output_prefix}_src.smi",
300
+ f"{self.output_prefix}_dns.dmi",
301
+ }
302
+ if (
303
+ self._window_file_path is not None
304
+ and self._window_file_path.parent == self.output_dir
305
+ ):
306
+ # Energy-window input written via set_energy_windows(); protect
307
+ # only that exact file, never a pre-existing one at the current
308
+ # prefix/location.
309
+ protected.add(self._window_file_path.name)
310
+ for slot in (5, 6):
311
+ try:
312
+ protected.add(self.config.get_data_file(slot))
313
+ except KeyError:
314
+ pass
315
+ for path in sorted(self.output_dir.iterdir()):
316
+ if not path.is_file() or path.name in protected:
317
+ continue
318
+ stem_ok = path.stem == self.output_prefix or path.stem.startswith(
319
+ f"{self.output_prefix}_"
320
+ )
321
+ if not stem_ok:
322
+ continue
323
+ if path.suffix in self._OUTPUT_SUFFIXES or (
324
+ path.suffix.startswith(".b")
325
+ and path.suffix[2:].isdigit()
326
+ and path.stem == self.output_prefix
327
+ ):
328
+ path.unlink()
329
+
244
330
  def _prepare_orbit_file(self, orbit_file: Optional[PathLike]) -> Optional[Path]:
245
331
  if orbit_file is None:
246
332
  return None
@@ -273,12 +359,18 @@ class SimindPythonConnector(BaseConnector):
273
359
  self.output_dir.glob(f"{self.output_prefix}_component_*.hs")
274
360
  )
275
361
  else:
276
- h00_files = sorted(self.output_dir.glob(f"*{self.output_prefix}*.h00"))
362
+ h00_files = sorted(
363
+ set(self.output_dir.glob(f"{self.output_prefix}_*.h00"))
364
+ | set(self.output_dir.glob(f"{self.output_prefix}.h00"))
365
+ )
277
366
  for h00_file in h00_files:
278
367
  hs_file = h00_file.with_suffix(".hs")
279
368
  self.converter.convert_file(str(h00_file), str(hs_file))
280
369
 
281
- hs_files = sorted(self.output_dir.glob(f"*{self.output_prefix}*.hs"))
370
+ hs_files = sorted(
371
+ set(self.output_dir.glob(f"{self.output_prefix}_*.hs"))
372
+ | {h00_file.with_suffix(".hs") for h00_file in h00_files}
373
+ )
282
374
  if not hs_files:
283
375
  raise FileNotFoundError(
284
376
  f"No projection headers (.hs) found for prefix {self.output_prefix!r} "
@@ -134,6 +134,11 @@ class PyTomographySimindAdaptor(BaseConnector):
134
134
  def run(
135
135
  self, runtime_operator: Optional[RuntimeOperator] = None
136
136
  ) -> Dict[str, torch.Tensor]:
137
+ # Clear all output caches up front so failed reruns cannot leak
138
+ # results from a previous successful run.
139
+ self._outputs = None
140
+ self._output_metadata = None
141
+ self._output_header_paths = None
137
142
  self._validate_inputs()
138
143
  assert self._source is not None # for type checkers
139
144
  assert self._mu_map is not None