multimodars 0.3.4__tar.gz → 0.4.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 (129) hide show
  1. multimodars-0.4.0/.gitattributes +9 -0
  2. {multimodars-0.3.4 → multimodars-0.4.0}/.gitignore +2 -0
  3. {multimodars-0.3.4 → multimodars-0.4.0}/CHANGELOG.md +90 -1
  4. {multimodars-0.3.4 → multimodars-0.4.0}/Cargo.lock +83 -266
  5. {multimodars-0.3.4 → multimodars-0.4.0}/Cargo.toml +8 -8
  6. {multimodars-0.3.4 → multimodars-0.4.0}/PKG-INFO +16 -11
  7. {multimodars-0.3.4 → multimodars-0.4.0}/README.md +15 -9
  8. {multimodars-0.3.4 → multimodars-0.4.0}/ROADMAP.MD +9 -14
  9. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/__init__.py +17 -1
  10. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/_converters.py +5 -1
  11. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/_processing.py +96 -24
  12. multimodars-0.4.0/multimodars/ccta/debug_plots.py +495 -0
  13. multimodars-0.4.0/multimodars/ccta/discretization_map.py +316 -0
  14. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/ccta/labeling.py +75 -0
  15. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/ccta/manipulating.py +298 -33
  16. multimodars-0.4.0/multimodars/io/__init__.py +2 -0
  17. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/io/read_geometrical.py +5 -2
  18. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/io/write_geometries.py +6 -5
  19. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/multimodars.pyi +166 -6
  20. {multimodars-0.3.4 → multimodars-0.4.0}/src/ccta/adjust_mesh/label_coronary.rs +56 -45
  21. {multimodars-0.3.4 → multimodars-0.4.0}/src/ccta/adjust_mesh/scale_coronary.rs +5 -0
  22. {multimodars-0.3.4 → multimodars-0.4.0}/src/ccta/binding/ccta_py.rs +311 -2
  23. multimodars-0.4.0/src/ccta/discretizing/mod.rs +26 -0
  24. multimodars-0.4.0/src/ccta/discretizing/plan.md +6 -0
  25. multimodars-0.4.0/src/ccta/discretizing/projecting.rs +520 -0
  26. multimodars-0.4.0/src/ccta/discretizing/resampling.rs +446 -0
  27. multimodars-0.4.0/src/ccta/discretizing/utils.rs +224 -0
  28. multimodars-0.4.0/src/ccta/discretizing/vessel_tree.rs +424 -0
  29. {multimodars-0.3.4 → multimodars-0.4.0}/src/ccta/mod.rs +1 -0
  30. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/binding/align.rs +60 -36
  31. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/binding/classes.rs +192 -23
  32. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/binding/entry.rs +8 -11
  33. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/binding/mod.rs +145 -34
  34. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/centerline_align/align_algorithms.rs +40 -26
  35. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/centerline_align/mod.rs +266 -34
  36. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/centerline_align/preprocessing.rs +45 -6
  37. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/io/geometry.rs +10 -12
  38. multimodars-0.4.0/src/intravascular/io/input.rs +1190 -0
  39. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/io/integrity_check.rs +3 -8
  40. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/io/mod.rs +3 -8
  41. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/io/output.rs +13 -16
  42. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/processing/align_between.rs +2 -4
  43. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/processing/align_within.rs +4 -4
  44. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/processing/postprocessing.rs +1 -1
  45. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/processing/preprocessing.rs +3 -7
  46. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/to_object/interpolation.rs +1 -1
  47. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/to_object/mod.rs +5 -11
  48. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/to_object/write_mtl.rs +15 -24
  49. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/utils/general_utils.rs +3 -3
  50. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/utils/test_utils.rs +1 -1
  51. {multimodars-0.3.4 → multimodars-0.4.0}/src/lib.rs +6 -3
  52. {multimodars-0.3.4 → multimodars-0.4.0}/tests/test_ccta.py +406 -21
  53. {multimodars-0.3.4 → multimodars-0.4.0}/tests/test_converters.py +3 -5
  54. {multimodars-0.3.4 → multimodars-0.4.0}/tests/test_core.py +0 -3
  55. {multimodars-0.3.4 → multimodars-0.4.0}/tests/test_intravascular.py +98 -0
  56. {multimodars-0.3.4 → multimodars-0.4.0}/tests/test_wrappers.py +0 -1
  57. multimodars-0.3.4/.github/workflows/draft-pdf.yml +0 -24
  58. multimodars-0.3.4/multimodars/ccta/debug_plots.py +0 -207
  59. multimodars-0.3.4/multimodars/io/__init__.py +0 -2
  60. multimodars-0.3.4/src/intravascular/io/input.rs +0 -557
  61. {multimodars-0.3.4 → multimodars-0.4.0}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  62. {multimodars-0.3.4 → multimodars-0.4.0}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
  63. {multimodars-0.3.4 → multimodars-0.4.0}/.github/PULL_REQUEST_TEMPLATE.md +0 -0
  64. {multimodars-0.3.4 → multimodars-0.4.0}/.github/workflows/CI.yml +0 -0
  65. {multimodars-0.3.4 → multimodars-0.4.0}/.pre-commit-config.yaml +0 -0
  66. {multimodars-0.3.4 → multimodars-0.4.0}/.readthedocs.yaml +0 -0
  67. {multimodars-0.3.4 → multimodars-0.4.0}/CITATION.cff +0 -0
  68. {multimodars-0.3.4 → multimodars-0.4.0}/CONTRIBUTING.md +0 -0
  69. {multimodars-0.3.4 → multimodars-0.4.0}/LICENSE +0 -0
  70. {multimodars-0.3.4 → multimodars-0.4.0}/benchmarks/BENCHMARK_PLAN.md +0 -0
  71. {multimodars-0.3.4 → multimodars-0.4.0}/benchmarks/benchmark_bruteforce_stepsize.py +0 -0
  72. {multimodars-0.3.4 → multimodars-0.4.0}/benchmarks/benchmark_cpu_scaling.py +0 -0
  73. {multimodars-0.3.4 → multimodars-0.4.0}/benchmarks/results/bruteforce_stepsize.png +0 -0
  74. {multimodars-0.3.4 → multimodars-0.4.0}/benchmarks/results/cpu_scaling.png +0 -0
  75. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/idealized_geometry/branch_diastolic_contours.csv +0 -0
  76. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/idealized_geometry/branch_systolic_contours.csv +0 -0
  77. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/idealized_geometry/calcium_diastolic_contours.csv +0 -0
  78. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/idealized_geometry/calcium_systolic_contours.csv +0 -0
  79. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/idealized_geometry/diastolic_contours.csv +0 -0
  80. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/idealized_geometry/diastolic_reference_points.csv +0 -0
  81. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/idealized_geometry/eem_diastolic_contours.csv +0 -0
  82. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/idealized_geometry/eem_systolic_contours.csv +0 -0
  83. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/idealized_geometry/systolic_contours.csv +0 -0
  84. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/idealized_geometry/systolic_reference_points.csv +0 -0
  85. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_full/branch_diastolic_contours.csv +0 -0
  86. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_full/branch_systolic_contours.csv +0 -0
  87. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_full/calcium_diastolic_contours.csv +0 -0
  88. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_full/calcium_systolic_contours.csv +0 -0
  89. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_full/diastolic_contours.csv +0 -0
  90. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_full/diastolic_reference_points.csv +0 -0
  91. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_full/eem_diastolic_contours.csv +0 -0
  92. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_full/eem_systolic_contours.csv +0 -0
  93. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_full/systolic_contours.csv +0 -0
  94. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_full/systolic_reference_points.csv +0 -0
  95. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_rest/combined_sorted_manual.csv +0 -0
  96. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_rest/diastolic_contours.csv +0 -0
  97. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_rest/diastolic_reference_points.csv +0 -0
  98. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_rest/systolic_contours.csv +0 -0
  99. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_rest/systolic_reference_points.csv +0 -0
  100. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_stress/combined_sorted_manual.csv +0 -0
  101. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_stress/diastolic_contours.csv +0 -0
  102. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_stress/diastolic_reference_points.csv +0 -0
  103. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_stress/systolic_contours.csv +0 -0
  104. {multimodars-0.3.4 → multimodars-0.4.0}/data/fixtures/ivus_stress/systolic_reference_points.csv +0 -0
  105. {multimodars-0.3.4 → multimodars-0.4.0}/media/coronary_artery_disease.jpg +0 -0
  106. {multimodars-0.3.4 → multimodars-0.4.0}/media/dynamic_lumen_changes.png +0 -0
  107. {multimodars-0.3.4 → multimodars-0.4.0}/media/multimoda-rs.jpg +0 -0
  108. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/ccta/__init__.py +0 -0
  109. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/ccta/fixing_functions.py +0 -0
  110. {multimodars-0.3.4 → multimodars-0.4.0}/multimodars/py.typed +0 -0
  111. {multimodars-0.3.4 → multimodars-0.4.0}/paper/REVIEWER1.md +0 -0
  112. {multimodars-0.3.4 → multimodars-0.4.0}/paper/REVIEWER2.md +0 -0
  113. {multimodars-0.3.4 → multimodars-0.4.0}/paper/bibliography.bib +0 -0
  114. {multimodars-0.3.4 → multimodars-0.4.0}/paper/figures/Figure1.jpg +0 -0
  115. {multimodars-0.3.4 → multimodars-0.4.0}/paper/figures/Figure2.jpg +0 -0
  116. {multimodars-0.3.4 → multimodars-0.4.0}/paper/figures/Figure3.png +0 -0
  117. {multimodars-0.3.4 → multimodars-0.4.0}/paper/figures/Figure4.jpg +0 -0
  118. {multimodars-0.3.4 → multimodars-0.4.0}/paper/paper.md +0 -0
  119. {multimodars-0.3.4 → multimodars-0.4.0}/pyproject.toml +0 -0
  120. {multimodars-0.3.4 → multimodars-0.4.0}/src/ccta/adjust_mesh/mod.rs +0 -0
  121. {multimodars-0.3.4 → multimodars-0.4.0}/src/ccta/binding/mod.rs +0 -0
  122. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/mod.rs +0 -0
  123. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/processing/mod.rs +0 -0
  124. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/processing/process_utils.rs +0 -0
  125. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/processing/wall.rs +0 -0
  126. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/to_object/texture.rs +0 -0
  127. {multimodars-0.3.4 → multimodars-0.4.0}/src/intravascular/utils/mod.rs +0 -0
  128. {multimodars-0.3.4 → multimodars-0.4.0}/tests/conftest.py +0 -0
  129. {multimodars-0.3.4 → multimodars-0.4.0}/tests/tests_todo.md +0 -0
@@ -0,0 +1,9 @@
1
+ # Exclude CSV files
2
+ *.csv linguist-generated=true
3
+
4
+ # Exclude Jupyter Notebook outputs
5
+ *.ipynb linguist-generated=true
6
+
7
+ # Exclude documentation files
8
+ *.md linguist-documentation=true
9
+ *.rst linguist-documentation=true
@@ -5,6 +5,8 @@
5
5
  /paper/old
6
6
  .VSCodeCounter
7
7
  /test
8
+ .mypy_cache/
9
+ .ruff_cache/
8
10
  examples/__pycache__/
9
11
  examples/logs/
10
12
  examples/data/output/
@@ -3,17 +3,106 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  This project adheres to [Semantic Versioning](https://semver.org/).
5
5
 
6
+ ## [0.4.0] - 2026-05-25
7
+ This version introduces backwards compatibility breaking changes.
8
+
9
+ ### Added
10
+
11
+ **Vessel-tree discretization pipeline**
12
+
13
+ - `prepare_centerlines(rca_cl, lca_cl, results_dict, branch_sigma, control_plot)`: one-call
14
+ wrapper that runs `calculate_branches`, `check_centerline`, and `label_branches` on both
15
+ coronary centerlines. Returns updated centerlines and a `results` dict extended with
16
+ `rca_points_main`, `rca_points_side_N`, `lca_points_main`, `lca_points_side_N` keys.
17
+ - `discretize_vessel_tree(ao_cl, rca_cl, lca_cl, results_dict, ...)`: slices each vessel along
18
+ its centerline at fixed arc-length intervals (`step_size`) and samples `n_points` evenly-spaced
19
+ points from each cross-sectional contour. Returns a `PyDiscretizedVesselTree` whose
20
+ `rca_references` / `lca_references` attributes hold orientation reference triplets at the
21
+ ostium and every side-branch bifurcation.
22
+ - `b_spline` / `bspline_smoothing` / `bspline_degree` parameters in `discretize_vessel_tree`:
23
+ when `b_spline=True`, each discretized contour is replaced with a closed periodic B-spline fit
24
+ (via `scipy.interpolate.splprep`) before reference points are computed. Smoothing strength is
25
+ controlled by `bspline_smoothing` (0 = exact interpolation; ≈ n_points = gentle;
26
+ ≈ 5 x n_points = strong).
27
+ - `find_sharp_angles(cl, branch_id, cos_threshold, control_plot)`: Python wrapper around the
28
+ Rust-bound `PyCenterline.find_sharp_angles` that prints a summary and, when `control_plot=True`,
29
+ opens a trimesh scene highlighting each flagged position in a distinct colour.
30
+
31
+ **Debug visualisations (trimesh-based)**
32
+
33
+ All debug plots now use `trimesh.Scene().show()` (native OpenGL) instead of Plotly, matching
34
+ the style of `label_geometry`'s control plot and working correctly in all environments
35
+ (VS Code, terminal, Jupyter).
36
+
37
+ - `plot_vessel_tree(tree, pts_per_contour)`: renders discretized contour rings, yellow centroid
38
+ traces, and the full orientation reference triplet for RCA and LCA. Color coding: silver =
39
+ aorta; steel-blue = RCA main; coral = LCA main; shades of blue/orange = side branches;
40
+ red/orange/magenta = main/CCW/CW reference points.
41
+ - `plot_centerline_branches(rca_cl, lca_cl, results_dict)`: shows each centerline branch in a
42
+ distinct colour; optionally overlays the labeled surface-mesh points semi-transparently.
43
+ - `plot_centerline_edges(cl, cos_threshold)`: shows all branches with red dots at positions
44
+ flagged by `find_sharp_angles` — useful for deciding where to call `split_branch`.
45
+ - `plot_sharp_angles(cl, branch_id, sharp_positions, context_pts)`: shows the full centerline
46
+ dimmed in gray with each flagged position and its neighbours highlighted in a distinct colour.
47
+ - `plot_results_key`, `compare_centerline_scaling`: migrated from Plotly to trimesh.
48
+
49
+ ### Changed
50
+
51
+ **Alignment reference point naming** (`align_three_point`, `align_combined`, `align_manual`)
52
+
53
+ The three landmark parameters have been renamed for anatomical clarity:
54
+
55
+ | Old name | New name |
56
+ |---|---|
57
+ | `aortic_ref_pt` | `main_ref_pt` |
58
+ | `upper_ref_pt` | `counterclockwise_ref_pt` |
59
+ | `lower_ref_pt` | `clockwise_ref_pt` |
60
+
61
+ The new names reflect the geometric meaning of each landmark (view from proximal to distal:
62
+ the CCW reference lies counter-clockwise of the vessel centre, the CW reference lies clockwise).
63
+ Updated across: Rust binding (`src/intravascular/binding/align.rs`), alignment algorithms
64
+ (`centerline_align/`), Python wrappers (`_processing.py`), type stubs (`multimodars.pyi`),
65
+ documentation (`tutorial_intravascular.rst`), and the CCTA notebook.
66
+
67
+ - `PyDiscretizedVesselTree.rca_references` / `lca_references` now store triplets as
68
+ `(main_ref, counterclockwise_ref, clockwise_ref)` matching the new parameter order.
69
+ - `PyCenterline` struct gains a new read-only field `branch_start_indices : list[int]`
70
+ (index into `points` where each branch begins; `branch_start_indices[0]` is always 0).
71
+ The constructor signature is unchanged — `PyCenterline(points=[...])` populates the field
72
+ automatically. **Note:** objects pickled with 0.3.x cannot be unpickled under 0.4.x.
73
+ - CCTA tutorial (`docs/tutorial_ccta.rst`) updated with new section 2 covering
74
+ `prepare_centerlines`, sharp-angle inspection/correction, and `discretize_vessel_tree`.
75
+ - CCTA notebook (`docs/notebooks/ccta_notebook.ipynb`) updated: section 2 added, section 3
76
+ uses `tree.rca_references[0]` and `rca_cl.get_branch(0)` for alignment.
77
+
78
+ ## [0.3.5] - 2026-05-15
79
+
80
+ ### Added
81
+ - `clamp_overshoot` parameter in `stitch_ccta_to_intravascular` (default 0.5 mm): for anomalous
82
+ ostia where the boundary-ring plane and the IV plane diverge by ≥ 45°, every proximal boundary
83
+ point is projected onto the IV plane and then pushed at least `clamp_overshoot` mm away from it,
84
+ creating an inward step that softens the stitching angle.
85
+ - `_enforce_layer_gap_from_plane`: the two mesh rings adjacent to the clamped boundary are
86
+ pushed radially outward within the IV plane (ring 1: 0.1 mm, ring 2: 0.2 mm) to eliminate
87
+ ridges at the clamping zone.
88
+ - Tests for `_clamp_to_plane`, `_enforce_layer_gap_from_plane`, and `_prepare_prox_dist_boundary_pts`
89
+ with idealized geometries (`test_ccta.py`, 17 tests).
90
+
91
+ ### Performance
92
+ - Ray-intersection labeling step parallelized via `par_iter()`, reducing wall time on large meshes.
93
+
6
94
  ## [0.3.4] - 2026-05-13
7
95
 
8
96
  ### Changed
9
97
  - `align_three_point`, `align_manual` and `align_combined` are now all generic, taking either `PyGeometryPair` or `PyGeometry` as input
10
98
  - Test file added `test_intravascular.py` to demonstrate that same results with both
11
99
 
12
- ## [0.3.3] - 2026-05-06
100
+ ## [0.3.3] - 2026-05-06 Release JOSS paper
13
101
 
14
102
  ### Added
15
103
  - `CITATION.cff` with full author list, ORCIDs, and preferred citation for JOSS/Zenodo archival.
16
104
  - Zenodo DOI badge added to README.
105
+ - Created a release coupled to JOSS publication
17
106
 
18
107
  ## [0.3.2] - 2026-05-05
19
108