aprict 0.0.34.dev8__tar.gz → 0.0.37__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 (166) hide show
  1. aprict-0.0.37/PKG-INFO +102 -0
  2. aprict-0.0.37/README.md +52 -0
  3. {aprict-0.0.34.dev8 → aprict-0.0.37}/pyproject.toml +12 -1
  4. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/__init__.py +4 -0
  5. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/version.py +1 -1
  6. aprict-0.0.37/src/aprict.egg-info/PKG-INFO +102 -0
  7. aprict-0.0.34.dev8/PKG-INFO +0 -313
  8. aprict-0.0.34.dev8/README.md +0 -272
  9. aprict-0.0.34.dev8/src/aprict.egg-info/PKG-INFO +0 -313
  10. {aprict-0.0.34.dev8 → aprict-0.0.37}/LICENSE.txt +0 -0
  11. {aprict-0.0.34.dev8 → aprict-0.0.37}/LICENSE_GPLv3.txt +0 -0
  12. {aprict-0.0.34.dev8 → aprict-0.0.37}/MANIFEST.in +0 -0
  13. {aprict-0.0.34.dev8 → aprict-0.0.37}/setup.cfg +0 -0
  14. {aprict-0.0.34.dev8 → aprict-0.0.37}/setup.py +0 -0
  15. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cb/__init__.py +0 -0
  16. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cb/_unused_old_fbp.py +0 -0
  17. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cb/flatpanel.py +0 -0
  18. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cb/noop_filter.py +0 -0
  19. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cb/ramp_filter.py +0 -0
  20. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cb/ramp_filter_cpu.py +0 -0
  21. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/__init__.py +0 -0
  22. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/_generate_cusrc.py +0 -0
  23. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/dtype_cacher.py +0 -0
  24. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/header_injection.py +0 -0
  25. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/kern_structs.py +0 -0
  26. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/ptx_cacher.py +0 -0
  27. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/FORBILD_volumes.py +0 -0
  28. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/__init__.py +0 -0
  29. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/base.py +0 -0
  30. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/config_cb_backproject.py +0 -0
  31. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/config_cb_project.py +0 -0
  32. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/config_cb_project_FORBILD.py +0 -0
  33. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Box.cu +0 -0
  34. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_ClipAxisSpec.cu +0 -0
  35. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Cone.cu +0 -0
  36. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Cone_x.cu +0 -0
  37. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Cone_y.cu +0 -0
  38. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Cone_z.cu +0 -0
  39. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Cylinder.cu +0 -0
  40. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Cylinder_x.cu +0 -0
  41. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Cylinder_y.cu +0 -0
  42. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Cylinder_z.cu +0 -0
  43. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Ellipsoid.cu +0 -0
  44. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Ellipsoid_free.cu +0 -0
  45. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Ellipt_Cyl.cu +0 -0
  46. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Ellipt_Cyl_x.cu +0 -0
  47. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Ellipt_Cyl_y.cu +0 -0
  48. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Ellipt_Cyl_z.cu +0 -0
  49. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Shape.cu +0 -0
  50. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/FORBILD_Sphere.cu +0 -0
  51. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/cu/__init__.py +0 -0
  52. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/geometry.py +0 -0
  53. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/test_subdir/__init__.py +0 -0
  54. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/cuda/structs/test_subdir/test_config.py +0 -0
  55. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/.gitignore +0 -0
  56. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/abdomen/AbdomenPhantom.pha +0 -0
  57. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/abdomen/AbdomenPhantom_fixed.pha +0 -0
  58. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/abdomen/TableOfTissues +0 -0
  59. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/abdomen/Wirbel.pha +0 -0
  60. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_composite/Ribs.pha +0 -0
  61. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_composite/Shoulders.pha +0 -0
  62. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_composite/TableOfTissues +0 -0
  63. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_composite/Vertebra.pha +0 -0
  64. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_composite/part_01_hip.pha +0 -0
  65. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_composite/part_02_abdomen.pha +0 -0
  66. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_composite/part_03_thorax.pha +0 -0
  67. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_composite/part_04_head.pha +0 -0
  68. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_composite/part_05_jaw.pha +0 -0
  69. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_other/rock_canister_01.pha +0 -0
  70. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_other/rock_canister_01_cavities_1e5.pha +0 -0
  71. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/custom_other/unit_Cyl_z.pha +0 -0
  72. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/head/HeadPhantom.pha +0 -0
  73. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/head/TableOfTissues +0 -0
  74. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/hip/HipPhantom.pha +0 -0
  75. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/jaw/JawPhantom.pha +0 -0
  76. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/lungs/LungPhantom3Generations.pha +0 -0
  77. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/thorax/Ribs.pha +0 -0
  78. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/thorax/Shoulders.pha +0 -0
  79. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/thorax/TableOfTissues +0 -0
  80. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/thorax/ThoraxPhantom.pha +0 -0
  81. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/FORBILD/thorax/Vertebra.pha +0 -0
  82. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/README.txt +0 -0
  83. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/CB_backproject.cu +0 -0
  84. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/CB_backproject_sharedmem.cu +0 -0
  85. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/CB_project_sharedmem.cu +0 -0
  86. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/CB_project_texture_chunked.cu +0 -0
  87. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/FORBILD_volumes.h +0 -0
  88. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/base.h +0 -0
  89. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/config_cb_backproject.h +0 -0
  90. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/config_cb_project.h +0 -0
  91. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/config_cb_project_FORBILD.h +0 -0
  92. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/geometry.h +0 -0
  93. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/get_bboxes_FORBILD.cu +0 -0
  94. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/ramlak_convolve.cu +0 -0
  95. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/sample_FORBILD_volumes.cu +0 -0
  96. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/test_kernel.cu +0 -0
  97. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/test_subdir/test_config.h +0 -0
  98. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/data/cusrc/texture_operations.cu +0 -0
  99. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/examples/__init__.py +0 -0
  100. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/examples/composite_human_sirt.py +0 -0
  101. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/examples/fan_beam_sirt.py +0 -0
  102. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/examples/helical_sirt.py +0 -0
  103. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/examples/lungs_sirt.py +0 -0
  104. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/examples/trajtest_A_sirt.py +0 -0
  105. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/examples/triangle_exp_fb.py +0 -0
  106. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/gbc/__init__.py +0 -0
  107. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/gbc/filters.py +0 -0
  108. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/gbc/weightinteg.py +0 -0
  109. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/image_view.py +0 -0
  110. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/iterators/__init__.py +0 -0
  111. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/iterators/landweber_vram.py +0 -0
  112. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/iterators/sirt_vram.py +0 -0
  113. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/__init__.py +0 -0
  114. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/argparse_tools.py +0 -0
  115. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/bboxes_FORBILD.py +0 -0
  116. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/click_tools.py +0 -0
  117. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/empty_context_manager.py +0 -0
  118. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/gpu_tools.py +0 -0
  119. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/import_tools.py +0 -0
  120. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/lds.py +0 -0
  121. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/ne_tools.py +0 -0
  122. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/ng_tools.py +0 -0
  123. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/np_tools.py +0 -0
  124. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/ome_zarr_tools.py +0 -0
  125. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/process_pha_file.py +0 -0
  126. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/sample_FORBILD.py +0 -0
  127. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/texture_tools/__init__.py +0 -0
  128. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/texture_tools/operations.py +0 -0
  129. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/lib/texture_tools/texture.py +0 -0
  130. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/liveplot.py +0 -0
  131. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/logtools/__init__.py +0 -0
  132. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/logtools/config.py +0 -0
  133. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/logtools/pbar.py +0 -0
  134. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/logtools/pbar_tqdm.py +0 -0
  135. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/logtools/rich_custombar.py +0 -0
  136. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/phantoms/FORBILD_phantoms.py +0 -0
  137. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/phantoms/__init__.py +0 -0
  138. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/ramp_kernels.py +0 -0
  139. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/__init__.py +0 -0
  140. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/cli.py +0 -0
  141. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/convert_npy_to_omezarr.py +0 -0
  142. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/convert_omezarr_to_npy.py +0 -0
  143. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/make_geometry_cone_cyl.py +0 -0
  144. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/make_geometry_fan_circ.py +0 -0
  145. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/neuroglance.py +0 -0
  146. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/project_cbfp.py +0 -0
  147. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/recon_cbfp_cyl_fbp.py +0 -0
  148. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/recon_cbfp_cyl_gbc.py +0 -0
  149. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/scripts/recon_cbfp_landweber.py +0 -0
  150. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/tests/__init__.py +0 -0
  151. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/tests/cuda_kernels/__init__.py +0 -0
  152. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/tests/cuda_kernels/test_backproject_cb.py +0 -0
  153. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/tests/cuda_kernels/test_cusrc/__init__.py +0 -0
  154. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/tests/cuda_kernels/test_kernel_structs.py +0 -0
  155. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/tests/cuda_kernels/test_project_cb.py +0 -0
  156. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/tests/cuda_kernels/test_project_cb_FORBILD_phantoms.py +0 -0
  157. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/tests/cuda_kernels/test_project_cb_FORBILD_shapes.py +0 -0
  158. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/tests/test_FORBILD_lungs_construction.py +0 -0
  159. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/tests/test_volume.py +0 -0
  160. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/volume/__init__.py +0 -0
  161. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict/volume/volume.py +0 -0
  162. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict.egg-info/SOURCES.txt +0 -0
  163. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict.egg-info/dependency_links.txt +0 -0
  164. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict.egg-info/entry_points.txt +0 -0
  165. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict.egg-info/requires.txt +0 -0
  166. {aprict-0.0.34.dev8 → aprict-0.0.37}/src/aprict.egg-info/top_level.txt +0 -0
aprict-0.0.37/PKG-INFO ADDED
@@ -0,0 +1,102 @@
1
+ Metadata-Version: 2.4
2
+ Name: aprict
3
+ Version: 0.0.37
4
+ Summary: Tools to simulate and reconstruct XCT transmission data.
5
+ Author: Murdock Grewar
6
+ Author-email: Murdock Grewar <murdock.grewar@anu.edu.au>
7
+ License-Expression: GPL-3.0-or-later
8
+ Project-URL: Documentation, https://docs.aprict.au/
9
+ Project-URL: Repository, https://github.com/murdock-grewar/aprict/
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Environment :: GPU :: NVIDIA CUDA
12
+ Classifier: Environment :: GPU :: NVIDIA CUDA :: 13
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Natural Language :: English
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: C++
17
+ Classifier: Programming Language :: Python :: 3 :: Only
18
+ Classifier: Programming Language :: Python :: 3.14
19
+ Classifier: Topic :: Scientific/Engineering
20
+ Requires-Python: >=3.14
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE.txt
23
+ License-File: LICENSE_GPLv3.txt
24
+ Requires-Dist: asteval>=1.0.10
25
+ Requires-Dist: click>=8.5.0
26
+ Requires-Dist: click-extra>=9.4.0
27
+ Requires-Dist: cuda-core[cu13]>=1.2.0
28
+ Requires-Dist: cupy-cuda13x[ctk]>=14.2.0
29
+ Requires-Dist: dask>=2026.8.0
30
+ Requires-Dist: gpustat>=1.1.1
31
+ Requires-Dist: imageio>=2.37.3
32
+ Requires-Dist: numexpr>=2.14.1
33
+ Requires-Dist: numpy>=2.4.3
34
+ Requires-Dist: ome-zarr>=0.21.0
35
+ Requires-Dist: pcpp>=1.30
36
+ Requires-Dist: pydantic>=2.12.5
37
+ Requires-Dist: regex>=2026.4.4
38
+ Requires-Dist: rich>=14.3.3
39
+ Requires-Dist: scipy>=1.17.1
40
+ Requires-Dist: tqdm>=4.68.3
41
+ Requires-Dist: zarr>=3.4.2
42
+ Provides-Extra: gui
43
+ Requires-Dist: imageio>=2.37.3; extra == "gui"
44
+ Requires-Dist: matplotlib>=3.10.8; extra == "gui"
45
+ Requires-Dist: pyqt6>=6.10.2; extra == "gui"
46
+ Requires-Dist: pyqtgraph>=0.14.0; extra == "gui"
47
+ Requires-Dist: neuroglancer>=2.41.0; extra == "gui"
48
+ Dynamic: author
49
+ Dynamic: license-file
50
+
51
+ ![project logo](https://raw.githubusercontent.com/murdock-grewar/aprict/refs/heads/release/img/logo_horz_big.svg)
52
+
53
+ [![Static Badge](https://img.shields.io/badge/Author_ORCiD-0000--0002--0015--8284-green?logo=orcid)](https://orcid.org/0000-0002-0015-8284)
54
+ [![Static Badge](https://img.shields.io/badge/Project_DOI-10.5281%2Fzenodo.23632625-yellow?logo=DOI&color=yellow)](https://doi.org/10.5281/zenodo.23632625)
55
+ [![PyPI Version](https://img.shields.io/pypi/v/aprict)](https://pypi.org/project/aprict/)
56
+ ![Static Badge](https://img.shields.io/badge/Install-pip_install_aprict%5Bgui%5D-212121?logo=PyPI&logoColor=white)
57
+ [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
58
+
59
+ # Description
60
+ `aprict` is a Python module for simulating transmission experiments in X-ray Computed Tomography, and for performing reconstructions from real and simulated data. In addition to the Python API, there is a commandline interface for some common operations.
61
+
62
+ ## Disclaimer
63
+ This software is provided with no warranty or guarantee of correctness. This is my research code sandbox, subject to breaking changes on a whim. This is not mature software. So, if you like it and wish to use it, then it is best to download a fixed version and use that. Updates may break things.
64
+
65
+ ## Features
66
+ `aprict` uses the GPU for all the heavy operations. The terminology 'in-core' an 'out-of-core' here refers to whether the relevant data must fit entirely within the GPU VRAM (in-core) or not (out-of-core). Most operations have no minimum RAM requirement in practice. Included features as of aprict==0.0.33:
67
+
68
+ - Out-of-core calculation of projection data for arbitrary flat-panel geometries. Supports voxelised volumes and (almost) any FORBILD phantom. (Exact line integrals in all cases.)
69
+ - Out-of-core analytic reconstruction for special geometries:
70
+ - Fan-beam data with circular scan
71
+ - Cone-beam data with cylindrical scan
72
+ - In-core iterative reconstruction (Landweber and SIRT) for arbitrary geometries.
73
+
74
+ # Documentation
75
+ ## Viewing online
76
+ The documentation for the latest release can be viewed online at [`https://docs.aprict.au/`](https://docs.aprict.au/).
77
+ ## Viewing locally
78
+ The documentation may be viewed locally by cloning the repository and running `python3 -m http.server -d aprict/docs/ 8080`, then navigating to `http://localhost:8080` in a browser window.
79
+
80
+ # Caveats
81
+ ## Hardware Requirements
82
+ This software requires at least one relatively recent *CUDA-capable GPU*. An RTX 3090 is recent enough. The relevant drivers will also need to be installed. You may need up-to-date drivers, depending on when the code was last updated.
83
+
84
+ It is strongly recommended to use high-speed mass storage, such as an NVMe drive. The software has not been tested on slower mass storage, and is not expected to perform well without it.
85
+
86
+ This software has been tested with the following GPUs:
87
+ * NVIDIA RTX 3090
88
+ * NVIDIA RTX PRO 6000 Blackwell
89
+
90
+ ## Known limitations
91
+ * Only flat-panel X-ray data with square pixels is supported, at this time.
92
+ * Lack of documentation:
93
+ * The way that geometry is encoded in `*.json` files is not yet documented.
94
+ * The encoding of projection data and volume data is not yet documented. (Numpy arrays; memory-mapped in the case of projections.)
95
+ * Implementation-related issues which could be alleviated in the future:
96
+ * Volume size is limited by CUDA texture limit. For example, a `(2400,2400,4800)` volume can be reconstructed, but not a `(30000,30000,1)` volume, due to a volume of this size not fitting within a single CUDA texture
97
+ * The FORBILD shape `Tetrahedron` is not yet implemented, and no primitive shape is permitted to have more than 3 clipping planes applied, due to internal limitations. All other FORBILD phantoms should be supported.
98
+ * Only one GPU is utilised by this module, at the present time. There is no defined behaviour for which GPU will be chosen.
99
+ * Not fully optimised
100
+ * CPU and GPU work not completely asynchronous: due to unresolved bugs, various asynchronous GPU operations have been disabled. This may not have much impact on large reconstructions, but could result in poor GPU utilisation for smaller reconstructions.
101
+ * No smart batching of (back)projections: smarter code would analyse the geometry of projections, and batch together (back)projections that involve similar regions of the volume. Currently, the code does not do any kind of clever batching like this, and so the (back)projection code is not as performant as it could be.
102
+
@@ -0,0 +1,52 @@
1
+ ![project logo](https://raw.githubusercontent.com/murdock-grewar/aprict/refs/heads/release/img/logo_horz_big.svg)
2
+
3
+ [![Static Badge](https://img.shields.io/badge/Author_ORCiD-0000--0002--0015--8284-green?logo=orcid)](https://orcid.org/0000-0002-0015-8284)
4
+ [![Static Badge](https://img.shields.io/badge/Project_DOI-10.5281%2Fzenodo.23632625-yellow?logo=DOI&color=yellow)](https://doi.org/10.5281/zenodo.23632625)
5
+ [![PyPI Version](https://img.shields.io/pypi/v/aprict)](https://pypi.org/project/aprict/)
6
+ ![Static Badge](https://img.shields.io/badge/Install-pip_install_aprict%5Bgui%5D-212121?logo=PyPI&logoColor=white)
7
+ [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
8
+
9
+ # Description
10
+ `aprict` is a Python module for simulating transmission experiments in X-ray Computed Tomography, and for performing reconstructions from real and simulated data. In addition to the Python API, there is a commandline interface for some common operations.
11
+
12
+ ## Disclaimer
13
+ This software is provided with no warranty or guarantee of correctness. This is my research code sandbox, subject to breaking changes on a whim. This is not mature software. So, if you like it and wish to use it, then it is best to download a fixed version and use that. Updates may break things.
14
+
15
+ ## Features
16
+ `aprict` uses the GPU for all the heavy operations. The terminology 'in-core' an 'out-of-core' here refers to whether the relevant data must fit entirely within the GPU VRAM (in-core) or not (out-of-core). Most operations have no minimum RAM requirement in practice. Included features as of aprict==0.0.33:
17
+
18
+ - Out-of-core calculation of projection data for arbitrary flat-panel geometries. Supports voxelised volumes and (almost) any FORBILD phantom. (Exact line integrals in all cases.)
19
+ - Out-of-core analytic reconstruction for special geometries:
20
+ - Fan-beam data with circular scan
21
+ - Cone-beam data with cylindrical scan
22
+ - In-core iterative reconstruction (Landweber and SIRT) for arbitrary geometries.
23
+
24
+ # Documentation
25
+ ## Viewing online
26
+ The documentation for the latest release can be viewed online at [`https://docs.aprict.au/`](https://docs.aprict.au/).
27
+ ## Viewing locally
28
+ The documentation may be viewed locally by cloning the repository and running `python3 -m http.server -d aprict/docs/ 8080`, then navigating to `http://localhost:8080` in a browser window.
29
+
30
+ # Caveats
31
+ ## Hardware Requirements
32
+ This software requires at least one relatively recent *CUDA-capable GPU*. An RTX 3090 is recent enough. The relevant drivers will also need to be installed. You may need up-to-date drivers, depending on when the code was last updated.
33
+
34
+ It is strongly recommended to use high-speed mass storage, such as an NVMe drive. The software has not been tested on slower mass storage, and is not expected to perform well without it.
35
+
36
+ This software has been tested with the following GPUs:
37
+ * NVIDIA RTX 3090
38
+ * NVIDIA RTX PRO 6000 Blackwell
39
+
40
+ ## Known limitations
41
+ * Only flat-panel X-ray data with square pixels is supported, at this time.
42
+ * Lack of documentation:
43
+ * The way that geometry is encoded in `*.json` files is not yet documented.
44
+ * The encoding of projection data and volume data is not yet documented. (Numpy arrays; memory-mapped in the case of projections.)
45
+ * Implementation-related issues which could be alleviated in the future:
46
+ * Volume size is limited by CUDA texture limit. For example, a `(2400,2400,4800)` volume can be reconstructed, but not a `(30000,30000,1)` volume, due to a volume of this size not fitting within a single CUDA texture
47
+ * The FORBILD shape `Tetrahedron` is not yet implemented, and no primitive shape is permitted to have more than 3 clipping planes applied, due to internal limitations. All other FORBILD phantoms should be supported.
48
+ * Only one GPU is utilised by this module, at the present time. There is no defined behaviour for which GPU will be chosen.
49
+ * Not fully optimised
50
+ * CPU and GPU work not completely asynchronous: due to unresolved bugs, various asynchronous GPU operations have been disabled. This may not have much impact on large reconstructions, but could result in poor GPU utilisation for smaller reconstructions.
51
+ * No smart batching of (back)projections: smarter code would analyse the geometry of projections, and batch together (back)projections that involve similar regions of the volume. Currently, the code does not do any kind of clever batching like this, and so the (back)projection code is not as performant as it could be.
52
+
@@ -12,9 +12,16 @@ readme = 'README.md'
12
12
  requires-python = '>=3.14'
13
13
  license = 'GPL-3.0-or-later'
14
14
  classifiers = [
15
+ 'Development Status :: 3 - Alpha',
16
+ 'Environment :: GPU :: NVIDIA CUDA',
17
+ 'Environment :: GPU :: NVIDIA CUDA :: 13',
18
+ 'Intended Audience :: Science/Research',
15
19
  'Natural Language :: English',
16
20
  'Operating System :: OS Independent',
17
- 'Programming Language :: Python :: 3',
21
+ 'Programming Language :: C++',
22
+ 'Programming Language :: Python :: 3 :: Only',
23
+ 'Programming Language :: Python :: 3.14',
24
+ 'Topic :: Scientific/Engineering',
18
25
  ]
19
26
  dependencies = [
20
27
  "asteval>=1.0.10",
@@ -38,6 +45,10 @@ dependencies = [
38
45
  ]
39
46
  dynamic = ['scripts', 'version']
40
47
 
48
+ [project.urls]
49
+ Documentation = "https://docs.aprict.au/"
50
+ Repository = "https://github.com/murdock-grewar/aprict/"
51
+
41
52
  [project.optional-dependencies]
42
53
  gui = [
43
54
  "imageio>=2.37.3",
@@ -24,6 +24,10 @@ r"""
24
24
 
25
25
  `aprict` is a Python module for simulating and reconstructing from flat-panel transmission X-ray experiments. In other words, it is a library for Cone-Beam Computed Tomography (CBCT).
26
26
 
27
+ ## Requirements
28
+
29
+ An NVIDIA GPU supporting CUDA 13.x is required to use `aprict`.
30
+
27
31
  ## Features
28
32
 
29
33
  `aprict` uses the GPU for all the heavy operations. The terminology 'in-core' and 'out-of-core' here refers to whether the relevant data must fit entirely within the GPU VRAM (in-core) or not (out-of-core). Most operations have no minimum RAM requirement in practice. Included features as of `aprict==0.0.33`:
@@ -16,4 +16,4 @@
16
16
  # This file is read from by 'setup.py', from '__init__.py', and also by a git hook which increments the dev number each time a commit is made on the 'dev' branch. There should only be one line in the file which begins with "version".
17
17
  """File which stores the current version number of this module."""
18
18
 
19
- version = "0.0.34.dev8"
19
+ version = "0.0.37"
@@ -0,0 +1,102 @@
1
+ Metadata-Version: 2.4
2
+ Name: aprict
3
+ Version: 0.0.37
4
+ Summary: Tools to simulate and reconstruct XCT transmission data.
5
+ Author: Murdock Grewar
6
+ Author-email: Murdock Grewar <murdock.grewar@anu.edu.au>
7
+ License-Expression: GPL-3.0-or-later
8
+ Project-URL: Documentation, https://docs.aprict.au/
9
+ Project-URL: Repository, https://github.com/murdock-grewar/aprict/
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Environment :: GPU :: NVIDIA CUDA
12
+ Classifier: Environment :: GPU :: NVIDIA CUDA :: 13
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Natural Language :: English
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: C++
17
+ Classifier: Programming Language :: Python :: 3 :: Only
18
+ Classifier: Programming Language :: Python :: 3.14
19
+ Classifier: Topic :: Scientific/Engineering
20
+ Requires-Python: >=3.14
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE.txt
23
+ License-File: LICENSE_GPLv3.txt
24
+ Requires-Dist: asteval>=1.0.10
25
+ Requires-Dist: click>=8.5.0
26
+ Requires-Dist: click-extra>=9.4.0
27
+ Requires-Dist: cuda-core[cu13]>=1.2.0
28
+ Requires-Dist: cupy-cuda13x[ctk]>=14.2.0
29
+ Requires-Dist: dask>=2026.8.0
30
+ Requires-Dist: gpustat>=1.1.1
31
+ Requires-Dist: imageio>=2.37.3
32
+ Requires-Dist: numexpr>=2.14.1
33
+ Requires-Dist: numpy>=2.4.3
34
+ Requires-Dist: ome-zarr>=0.21.0
35
+ Requires-Dist: pcpp>=1.30
36
+ Requires-Dist: pydantic>=2.12.5
37
+ Requires-Dist: regex>=2026.4.4
38
+ Requires-Dist: rich>=14.3.3
39
+ Requires-Dist: scipy>=1.17.1
40
+ Requires-Dist: tqdm>=4.68.3
41
+ Requires-Dist: zarr>=3.4.2
42
+ Provides-Extra: gui
43
+ Requires-Dist: imageio>=2.37.3; extra == "gui"
44
+ Requires-Dist: matplotlib>=3.10.8; extra == "gui"
45
+ Requires-Dist: pyqt6>=6.10.2; extra == "gui"
46
+ Requires-Dist: pyqtgraph>=0.14.0; extra == "gui"
47
+ Requires-Dist: neuroglancer>=2.41.0; extra == "gui"
48
+ Dynamic: author
49
+ Dynamic: license-file
50
+
51
+ ![project logo](https://raw.githubusercontent.com/murdock-grewar/aprict/refs/heads/release/img/logo_horz_big.svg)
52
+
53
+ [![Static Badge](https://img.shields.io/badge/Author_ORCiD-0000--0002--0015--8284-green?logo=orcid)](https://orcid.org/0000-0002-0015-8284)
54
+ [![Static Badge](https://img.shields.io/badge/Project_DOI-10.5281%2Fzenodo.23632625-yellow?logo=DOI&color=yellow)](https://doi.org/10.5281/zenodo.23632625)
55
+ [![PyPI Version](https://img.shields.io/pypi/v/aprict)](https://pypi.org/project/aprict/)
56
+ ![Static Badge](https://img.shields.io/badge/Install-pip_install_aprict%5Bgui%5D-212121?logo=PyPI&logoColor=white)
57
+ [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
58
+
59
+ # Description
60
+ `aprict` is a Python module for simulating transmission experiments in X-ray Computed Tomography, and for performing reconstructions from real and simulated data. In addition to the Python API, there is a commandline interface for some common operations.
61
+
62
+ ## Disclaimer
63
+ This software is provided with no warranty or guarantee of correctness. This is my research code sandbox, subject to breaking changes on a whim. This is not mature software. So, if you like it and wish to use it, then it is best to download a fixed version and use that. Updates may break things.
64
+
65
+ ## Features
66
+ `aprict` uses the GPU for all the heavy operations. The terminology 'in-core' an 'out-of-core' here refers to whether the relevant data must fit entirely within the GPU VRAM (in-core) or not (out-of-core). Most operations have no minimum RAM requirement in practice. Included features as of aprict==0.0.33:
67
+
68
+ - Out-of-core calculation of projection data for arbitrary flat-panel geometries. Supports voxelised volumes and (almost) any FORBILD phantom. (Exact line integrals in all cases.)
69
+ - Out-of-core analytic reconstruction for special geometries:
70
+ - Fan-beam data with circular scan
71
+ - Cone-beam data with cylindrical scan
72
+ - In-core iterative reconstruction (Landweber and SIRT) for arbitrary geometries.
73
+
74
+ # Documentation
75
+ ## Viewing online
76
+ The documentation for the latest release can be viewed online at [`https://docs.aprict.au/`](https://docs.aprict.au/).
77
+ ## Viewing locally
78
+ The documentation may be viewed locally by cloning the repository and running `python3 -m http.server -d aprict/docs/ 8080`, then navigating to `http://localhost:8080` in a browser window.
79
+
80
+ # Caveats
81
+ ## Hardware Requirements
82
+ This software requires at least one relatively recent *CUDA-capable GPU*. An RTX 3090 is recent enough. The relevant drivers will also need to be installed. You may need up-to-date drivers, depending on when the code was last updated.
83
+
84
+ It is strongly recommended to use high-speed mass storage, such as an NVMe drive. The software has not been tested on slower mass storage, and is not expected to perform well without it.
85
+
86
+ This software has been tested with the following GPUs:
87
+ * NVIDIA RTX 3090
88
+ * NVIDIA RTX PRO 6000 Blackwell
89
+
90
+ ## Known limitations
91
+ * Only flat-panel X-ray data with square pixels is supported, at this time.
92
+ * Lack of documentation:
93
+ * The way that geometry is encoded in `*.json` files is not yet documented.
94
+ * The encoding of projection data and volume data is not yet documented. (Numpy arrays; memory-mapped in the case of projections.)
95
+ * Implementation-related issues which could be alleviated in the future:
96
+ * Volume size is limited by CUDA texture limit. For example, a `(2400,2400,4800)` volume can be reconstructed, but not a `(30000,30000,1)` volume, due to a volume of this size not fitting within a single CUDA texture
97
+ * The FORBILD shape `Tetrahedron` is not yet implemented, and no primitive shape is permitted to have more than 3 clipping planes applied, due to internal limitations. All other FORBILD phantoms should be supported.
98
+ * Only one GPU is utilised by this module, at the present time. There is no defined behaviour for which GPU will be chosen.
99
+ * Not fully optimised
100
+ * CPU and GPU work not completely asynchronous: due to unresolved bugs, various asynchronous GPU operations have been disabled. This may not have much impact on large reconstructions, but could result in poor GPU utilisation for smaller reconstructions.
101
+ * No smart batching of (back)projections: smarter code would analyse the geometry of projections, and batch together (back)projections that involve similar regions of the volume. Currently, the code does not do any kind of clever batching like this, and so the (back)projection code is not as performant as it could be.
102
+
@@ -1,313 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: aprict
3
- Version: 0.0.34.dev8
4
- Summary: Tools to simulate and reconstruct XCT transmission data.
5
- Author: Murdock Grewar
6
- Author-email: Murdock Grewar <murdock.grewar@anu.edu.au>
7
- License-Expression: GPL-3.0-or-later
8
- Classifier: Natural Language :: English
9
- Classifier: Operating System :: OS Independent
10
- Classifier: Programming Language :: Python :: 3
11
- Requires-Python: >=3.14
12
- Description-Content-Type: text/markdown
13
- License-File: LICENSE.txt
14
- License-File: LICENSE_GPLv3.txt
15
- Requires-Dist: asteval>=1.0.10
16
- Requires-Dist: click>=8.5.0
17
- Requires-Dist: click-extra>=9.4.0
18
- Requires-Dist: cuda-core[cu13]>=1.2.0
19
- Requires-Dist: cupy-cuda13x[ctk]>=14.2.0
20
- Requires-Dist: dask>=2026.8.0
21
- Requires-Dist: gpustat>=1.1.1
22
- Requires-Dist: imageio>=2.37.3
23
- Requires-Dist: numexpr>=2.14.1
24
- Requires-Dist: numpy>=2.4.3
25
- Requires-Dist: ome-zarr>=0.21.0
26
- Requires-Dist: pcpp>=1.30
27
- Requires-Dist: pydantic>=2.12.5
28
- Requires-Dist: regex>=2026.4.4
29
- Requires-Dist: rich>=14.3.3
30
- Requires-Dist: scipy>=1.17.1
31
- Requires-Dist: tqdm>=4.68.3
32
- Requires-Dist: zarr>=3.4.2
33
- Provides-Extra: gui
34
- Requires-Dist: imageio>=2.37.3; extra == "gui"
35
- Requires-Dist: matplotlib>=3.10.8; extra == "gui"
36
- Requires-Dist: pyqt6>=6.10.2; extra == "gui"
37
- Requires-Dist: pyqtgraph>=0.14.0; extra == "gui"
38
- Requires-Dist: neuroglancer>=2.41.0; extra == "gui"
39
- Dynamic: author
40
- Dynamic: license-file
41
-
42
- ![project logo](https://raw.githubusercontent.com/murdock-grewar/aprict/refs/heads/release/img/logo_horz_big.svg)
43
-
44
- [![Static Badge](https://img.shields.io/badge/Author_ORCiD-0000--0002--0015--8284-green?logo=orcid)](https://orcid.org/0000-0002-0015-8284)
45
- [![Static Badge](https://img.shields.io/badge/Project_DOI-10.5281%2Fzenodo.23632625-yellow?logo=DOI&color=yellow)](https://doi.org/10.5281/zenodo.23632625)
46
- [![PyPI Version](https://img.shields.io/pypi/v/aprict)](https://pypi.org/project/aprict/)
47
- ![Static Badge](https://img.shields.io/badge/Install-pip_install_aprict%5Bgui%5D-212121?logo=PyPI&logoColor=white)
48
- [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
49
-
50
- <details open><summary><h1>About</h1></summary>
51
-
52
- Description
53
- ---
54
-
55
- `aprict` is a Python module for simulating transmission experiments in X-ray Computed Tomography, and for performing reconstructions from real and simulated data. In addition to the Python API, there is a commandline interface for some common operations.
56
-
57
- API documentation
58
- ---
59
- The Python API documentation is limited and incomplete, but available in the `docs/` directory. The documentation for the latest release may also be hosted at [`docs.aprict.au`](https://docs.aprict.au/).
60
-
61
- Disclaimer
62
- ---
63
-
64
- This software is provided with no warranty or guarantee of correctness. This is my research code sandbox, subject to breaking changes on a whim. This is not mature software. So, if you like it and wish to use it, then it is best to download a fixed version and use that. Updates are very likely to break things.
65
-
66
- Hardware Requirements
67
- ---
68
-
69
- This software requires at least one relatively recent *CUDA-capable GPU*. An RTX 3090 is recent enough. The relevant drivers will also need to be installed. You may need up-to-date drivers, depending on when the code was last updated.
70
-
71
- It is strongly recommended to use high-speed mass storage, such as an NVMe drive. The software has not been tested on slower mass storage, and is not expected to perform well without it.
72
-
73
- This software has been tested with the following GPUs:
74
- * NVIDIA RTX 3090
75
- * NVIDIA RTX PRO 6000 Blackwell
76
-
77
- Known limitations
78
- ---
79
-
80
- * Only flat-panel X-ray data with square pixels is supported, at this time.
81
- * Lack of documentation:
82
- * The way that geometry is encoded in `*.json` files is not yet documented.
83
- * The encoding of projection data and volume data is not yet documented. (Numpy arrays; memory-mapped in the case of projections.)
84
- * Implementation-related issues which could be alleviated in the future:
85
- * Volume size is limited by CUDA texture limit. For example, a `(2400,2400,4800)` volume can be reconstructed, but not a `(30000,30000,1)` volume, due to a volume of this size not fitting within a single CUDA texture
86
- * The FORBILD shape `Tetrahedron` is not yet implemented, and no primitive shape is permitted to have more than 3 clipping planes applied, due to internal limitations. All other FORBILD phantoms should be supported.
87
- * Only one GPU is utilised by this module, at the present time. There is no defined behaviour for which GPU will be chosen.
88
- * Not fully optimised
89
- * CPU and GPU work not completely asynchronous: due to unresolved bugs, various asynchronous GPU operations have been disabled. This may not have much impact on large reconstructions, but could result in poor GPU utilisation for smaller reconstructions.
90
- * No smart batching of (back)projections: smarter code would analyse the geometry of projections, and batch together (back)projections that involve similar regions of the volume. Currently, the code does not do any kind of clever batching like this, and so the (back)projection code is not as performant as it could be.
91
-
92
- Features
93
- ---
94
-
95
- * Simulation of projection data for almost any flat-panel geometry, with almost any FORBILD phantom. Also supports voxelised volumes. The projection code computes exact line integrals (including through voxelised volumes composed of voxels of uniform attenuation coefficient), and can accept arbtirary phantoms defined in `*.pha` files using the FORBILD format. The accuracy can be further increased by averaging multiple line integrals for each pixel. The source and detector can even be placed _inside_ the object, and projection will still be accurately computed from the source point to the detector pixels.
96
- * Several built-in phantoms included for the user's convenience.
97
- * GBC and FBP reconstruction scripts supplied. These work efficiently with projection datasets of any size, e.g. a 200 GiB+ set is OK. (Requires high-speed mass storage for rapid reading/writing, e.g. an NVMe drive.)
98
-
99
- * Analytic reconstruction from:
100
- * Fan-beam data with circular scan
101
- * Cone-beam data with cylindrical scan
102
-
103
- </details>
104
-
105
- <details><summary><h1>Setup</h1></summary>
106
-
107
- Installation
108
- ---
109
-
110
- You can install `aprict` like you would any python package, using `pip install`. It is recommended to install it with the `[gui]` extra if possible, as this will enable plotting capabilities. This may require `PyQt6` or `pyside` or some other GUI backend to be installed on your system. Try installing with `[gui]` first, if you can. This README will assume that the `[gui]` extra is installed.
111
-
112
- Example installation using `uv`:
113
- ```bash
114
- $ uv venv -p 3.14
115
- $ uv pip install aprict[gui]==0.0.24
116
- $ source .venv/bin/activate
117
- ```
118
- You should now have several executables available on `$PATH`. Try `aprict-cli --help` to see the polished commandline interface.
119
-
120
- If you're using Windows, then it's recommended to install this inside the Windows Subsystem for Linux (WSL).
121
- </details>
122
-
123
-
124
- <details><summary><h1>Example usage with the Commandline Interface (CLI)</h1></summary>
125
-
126
-
127
- Commandline interface (CLI)
128
- ---
129
-
130
- Activate the environment:
131
- ```bash
132
- source .venv/bin/activate
133
- ```
134
- Now, try the shell command `aprict-cli --help`. Here is the output as at `v0.0.24`:
135
- ```
136
- Usage: aprict-cli [OPTIONS] COMMAND [ARGS]...
137
-
138
- Entry point for CLI interface to aprict version 0.0.24
139
-
140
- Options:
141
- --version Show the version and exit.
142
- --tree Show the tree of nested subcommands and exit.
143
- -h, --help Show this message and exit.
144
-
145
- Commands:
146
- help Show help for a command.
147
- make-geom Make a geometry object.
148
- project Generate projection data.
149
- recon Tomographic reconstruction routines.
150
- ```
151
-
152
- You can use the `--help` option with any command to see its detailed usage information.
153
-
154
-
155
- <details><summary><h2>Example A: cone-beam; cylindrical source distribution</h2></summary>
156
-
157
- Here's an example where we will use the CLI to simulate data from the FORBILD Head phantom, and reconstruct a tomogram from that data.
158
-
159
- Start by creating a clean directory to work in:
160
- ```bash
161
- mkdir headtest
162
- cd headtest
163
- ```
164
-
165
- Now, the first step is to create a `.json` file representing the experiment geometry. This can be done like so:
166
- ```bash
167
- aprict-cli make-geom cone-cyl \
168
- --num 2000 \
169
- --R 250 --L-minus-R 250 --h 700 \
170
- --detwid 600 --dethei 600 \
171
- --pixwid-isoc 0.25 --pixhei-isoc 0.25 \
172
- --output projgeom.json
173
- ```
174
- You might like to open this file in a text editor, to get a feel for what's inside. It describes an experiment geometry with a flat-panel trajectory.
175
-
176
- Now, let's generate accurate, noiseless projection data from this geometry. We can specify any FORBILD file, assumed to have a file suffix of `.pha`, using the `--phantom file.pha` option. However, there are also a few built-in presets for convenience. Let's use `--phantom-preset HEAD`, which refers to the FORBILD Head phantom, with distances specified in units of millimeters.
177
- ```bash
178
- aprict-cli project cbfp \
179
- --geom projgeom.json \
180
- --phantom-preset HEAD \
181
- --ssu 3 \
182
- --ssv 3 \
183
- --output projs \
184
- --plot-mode PYQTGRAPH
185
- ````
186
- (Time on my machine: ~2 minutes, 56 seconds)
187
- The options `--ssu 3 --ssv 3` indicate that the line attenuation for each detector pixel is to be calculated as the average of a 3-by-3 grid of exact line integrals. This kind of improved accuracy is necessary for some phantoms, including this one, if using a large detector pixel size. The option `--plot-mode PYQTGRAPH` will display a plot window of the projection data after it is created. (This will not be available if the module was not installed with the `[gui]` option.)
188
-
189
- Now, let's reconstruct with three different algorithms:
190
- 1. Global Backprojection-Convolution (GBC)
191
- 2. Filtered backprojection (FBP)
192
- 3. Filtered backprojection with volumetric weightings (FBP-VW)
193
-
194
- To perform a GBC reconstruction, we do:
195
- ```bash
196
- aprict-cli recon gbc-cone-cyl \
197
- --geom projs/projgeom.json \
198
- --projs projs/projs.npy \
199
- --voxwid 0.5 \
200
- --volshape '(525,525,525)' \
201
- --alg GREWAR \
202
- --f1 1.2 \
203
- --f2 6 \
204
- --n 9 \
205
- --eps 1e-9 \
206
- --output recon_gbc \
207
- --plot-mode PYQTGRAPH
208
- ```
209
- (Time on my machine: ~39 seconds)
210
-
211
- To perform an FBP reconstruction, we do:
212
- ```bash
213
- aprict-cli recon fbp-cone-cyl \
214
- --geom projs/projgeom.json \
215
- --projs projs/projs.npy \
216
- --voxwid 0.5 \
217
- --volshape '(525,525,525)' \
218
- --alg STANDARD \
219
- --output recon_fbp \
220
- --plot-mode PYQTGRAPH
221
- ```
222
- (Time on my machine: ~19 seconds)
223
-
224
- To perform an FBP-VM reconstruction, we change `--alg` to `NOOGREWAR`:
225
- ```bash
226
- aprict-cli recon fbp-cone-cyl \
227
- --geom projs/projgeom.json \
228
- --projs projs/projs.npy \
229
- --voxwid 0.5 \
230
- --volshape '(525,525,525)' \
231
- --alg NOOGREWAR \
232
- --output recon_fbp-vw \
233
- --plot-mode PYQTGRAPH
234
- ```
235
- (Time on my machine: ~26 seconds)
236
-
237
-
238
- </details>
239
-
240
-
241
- <details><summary><h2>Example B: fan-beam; circular source distribution</h2></summary>
242
-
243
- Here's an example where we will use the CLI to simulate data from a FORBILD phantom resembling a double-chambered aluminium rock canister phantom.
244
-
245
- Start by creating a clean directory to work in:
246
- ```bash
247
- mkdir rockcantest
248
- cd rockcantest
249
- ```
250
-
251
- The first step is to create a `.json` file representing the fan-beam experiment geometry. This can be done like so:
252
- ```bash
253
- aprict-cli make-geom fan-circ \
254
- --num 300 \
255
- --R 4 --L-minus-R 4 \
256
- --detwid 17.5 --nv 1 \
257
- --pixwid-isoc 0.002 --pixhei-isoc 0.002 \
258
- --output projgeom.json
259
- ```
260
- Note the option `--nv 1`, which specifies that the detector height should be 1 pixel, which is appropriate for a fan-beam experiment, where we only intend to reconstruct a single z slice of the phantom. This is an alternative to supplying the `--dethei` option. Some options, such as these, are mutually exclusive. Use `aprict-cli make-geom fan-circ --help` to see detailed information about this.
261
-
262
- Now, let's generate projection data from the phantom preset called `ROCK_CAN`. The `z=0` layer of the phantom is not all that interesting, so we'll also translate the input phantom down along the `z` axis by `-2.7` units (millimeters, in this case). Additionally, since we intend on simulating a 2D phantom here, we only want to sample rays at the vertical centre of each pixel. So, we will supply `--ssv 1` to ensure that only the middle of each pixel is used for ray end-points. The option `--ssu 100` ensures that 100 fanning rays are averaged to compute the projected attenuation at each pixel. This ensures greater accuracy, particularly in the presence of small features which may otherwise be missed by the pixel size.
263
- ```bash
264
- aprict-cli project cbfp \
265
- --geom projgeom.json \
266
- --phantom-preset ROCK_CAN \
267
- --translate-vol '(0,0,-2.7)' \
268
- --ssu 100 \
269
- --ssv 1 \
270
- --output projs \
271
- --plot-mode PYQTGRAPH
272
- ````
273
- (Time on my machine: ~1 minute, 48 seconds)
274
- The option `--plot-mode PYQTGRAPH` will display a plot window of the projection data (a sinogram) after it is created. (This will not be available if the module was not installed with the `[gui]` option.)
275
-
276
- You will find a copy of the `ROCK_CAN` phantom in the output directory `projs`, beside the projection data. The phantom is always copied to the output directory, to ensure a good record of the inputs to the simulation.
277
-
278
- Finally, let's perform a reconstruction using a filtered backprojection (FBP) method for this geometry:
279
- ```bash
280
- aprict-cli recon fbp-fan-circ \
281
- --geom projs/projgeom.json \
282
- --projs projs/projs.npy \
283
- --voxwid 0.002 \
284
- --volshape '(3000,3000,1)' \
285
- --alg STANDARD \
286
- --output recon_standard \
287
- --plotmin -0.25 \
288
- --plotmax 2.25 \
289
- --plot-mode PYQTGRAPH
290
- ```
291
- (Time on my machine: ~2 seconds)
292
- Once again, the option `--plot-mode PYQTGRAPH` ensures that a plot window will pop up once the reconstruction is done. Note the `--plotmin -0.25` and `--plotmax 2.25` options here, which control the plotting range of the saved `*.png` files in the output directory. The whole volume is stored as a numpy array (`*.npy`), but it's useful to have some preview PNGs generated as well.
293
-
294
-
295
- The previous reconstruction contains a lot of undersampling artefacts, due to the small number of projections (`300`). To a lesser extent, it also contains aliasing artefacts, due to the (de)magnified pixel size subceeding the voxel size. So, let's try an alternative algorithm that better handles this situation, at the expensive of reduced sharpness on the edges. This can be done by specifying `--alg NOOGREWAR`:
296
- ```bash
297
- aprict-cli recon fbp-fan-circ \
298
- --geom projs/projgeom.json \
299
- --projs projs/projs.npy \
300
- --voxwid 0.002 \
301
- --volshape '(3000,3000,1)' \
302
- --alg NOOGREWAR \
303
- --output recon_noogrewar \
304
- --plotmin -0.25 \
305
- --plotmax 2.25 \
306
- --plot-mode PYQTGRAPH
307
- ```
308
- (Time on my machine: ~2 seconds)
309
-
310
- </details>
311
-
312
-
313
- </details>