mlxradiomics 1.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.
- mlxradiomics-1.0.0/.gitignore +41 -0
- mlxradiomics-1.0.0/LICENSE +202 -0
- mlxradiomics-1.0.0/PKG-INFO +265 -0
- mlxradiomics-1.0.0/README.md +225 -0
- mlxradiomics-1.0.0/THIRD_PARTY_NOTICES.md +109 -0
- mlxradiomics-1.0.0/pyproject.toml +123 -0
- mlxradiomics-1.0.0/src/mlxradiomics/__init__.py +87 -0
- mlxradiomics-1.0.0/src/mlxradiomics/config/__init__.py +1 -0
- mlxradiomics-1.0.0/src/mlxradiomics/config/filtering.py +137 -0
- mlxradiomics-1.0.0/src/mlxradiomics/config/parameters.py +630 -0
- mlxradiomics-1.0.0/src/mlxradiomics/config/settings.py +500 -0
- mlxradiomics-1.0.0/src/mlxradiomics/config/spatial.py +118 -0
- mlxradiomics-1.0.0/src/mlxradiomics/config/transforms.py +616 -0
- mlxradiomics-1.0.0/src/mlxradiomics/config/validation.py +59 -0
- mlxradiomics-1.0.0/src/mlxradiomics/config/wavelets.py +57 -0
- mlxradiomics-1.0.0/src/mlxradiomics/contracts/__init__.py +1 -0
- mlxradiomics-1.0.0/src/mlxradiomics/contracts/json.py +23 -0
- mlxradiomics-1.0.0/src/mlxradiomics/contracts/metadata.py +129 -0
- mlxradiomics-1.0.0/src/mlxradiomics/contracts/results.py +43 -0
- mlxradiomics-1.0.0/src/mlxradiomics/contracts/types.py +279 -0
- mlxradiomics-1.0.0/src/mlxradiomics/contracts/validity.py +36 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/__init__.py +1 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/aggregation.py +351 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/cooccurrence.py +226 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/distributions.py +356 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/first_order.py +930 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/first_order_source.py +157 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/geometry/__init__.py +1 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/geometry/arithmetic.py +171 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/geometry/boxes.py +209 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/geometry/diameters.py +189 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/geometry/ellipsoids.py +719 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/geometry/hull.py +70 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/geometry/mesh.py +316 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/geometry/mesh_tables.json +4870 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/geometry/moments.py +297 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/glcm.py +403 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/integer_quantiles.py +70 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/intensity_histogram.py +336 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/ivh.py +338 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/local_intensity.py +432 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/matrices.py +324 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/morphology.py +495 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/selection.py +27 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/shape.py +412 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/sparse_glcm.py +156 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/sparse_size.py +153 -0
- mlxradiomics-1.0.0/src/mlxradiomics/features/texture.py +615 -0
- mlxradiomics-1.0.0/src/mlxradiomics/filters/__init__.py +41 -0
- mlxradiomics-1.0.0/src/mlxradiomics/filters/_kernels.py +94 -0
- mlxradiomics-1.0.0/src/mlxradiomics/filters/convolution.py +752 -0
- mlxradiomics-1.0.0/src/mlxradiomics/filters/lbp2d.py +249 -0
- mlxradiomics-1.0.0/src/mlxradiomics/filters/lbp3d.py +242 -0
- mlxradiomics-1.0.0/src/mlxradiomics/filters/recursive_gaussian.py +376 -0
- mlxradiomics-1.0.0/src/mlxradiomics/filters/riesz_steering.py +742 -0
- mlxradiomics-1.0.0/src/mlxradiomics/filters/spectral.py +533 -0
- mlxradiomics-1.0.0/src/mlxradiomics/imaging/__init__.py +1 -0
- mlxradiomics-1.0.0/src/mlxradiomics/imaging/io.py +328 -0
- mlxradiomics-1.0.0/src/mlxradiomics/imaging/preprocessing.py +546 -0
- mlxradiomics-1.0.0/src/mlxradiomics/imaging/spatial.py +458 -0
- mlxradiomics-1.0.0/src/mlxradiomics/imaging/transforms.py +771 -0
- mlxradiomics-1.0.0/src/mlxradiomics/imaging/wavelet_tables.json +1 -0
- mlxradiomics-1.0.0/src/mlxradiomics/medmlx.py +251 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/__init__.py +1 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/count_statistics.py +70 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/eigen.py +182 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/histogram.py +203 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/pair_arithmetic.py +170 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/precision.py +319 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/protocols.py +59 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/reduction.py +354 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/runtime.py +86 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/sparse_counts.py +79 -0
- mlxradiomics-1.0.0/src/mlxradiomics/numerics/spline.py +129 -0
- mlxradiomics-1.0.0/src/mlxradiomics/py.typed +0 -0
- mlxradiomics-1.0.0/src/mlxradiomics/viz/__init__.py +17 -0
- mlxradiomics-1.0.0/src/mlxradiomics/viz/_backend.py +81 -0
- mlxradiomics-1.0.0/src/mlxradiomics/viz/rendering.py +286 -0
- mlxradiomics-1.0.0/src/mlxradiomics/voxel/__init__.py +1 -0
- mlxradiomics-1.0.0/src/mlxradiomics/voxel/extraction.py +705 -0
- mlxradiomics-1.0.0/src/mlxradiomics/voxel/gather.py +90 -0
- mlxradiomics-1.0.0/src/mlxradiomics/voxel/glcm.py +670 -0
- mlxradiomics-1.0.0/src/mlxradiomics/voxel/storage.py +172 -0
- mlxradiomics-1.0.0/src/mlxradiomics/voxel/texture.py +653 -0
- mlxradiomics-1.0.0/src/mlxradiomics/workflows/__init__.py +1 -0
- mlxradiomics-1.0.0/src/mlxradiomics/workflows/derived.py +289 -0
- mlxradiomics-1.0.0/src/mlxradiomics/workflows/engine.py +341 -0
- mlxradiomics-1.0.0/src/mlxradiomics/workflows/exporting.py +167 -0
- mlxradiomics-1.0.0/src/mlxradiomics/workflows/extraction.py +427 -0
- mlxradiomics-1.0.0/src/mlxradiomics/workflows/publication.py +280 -0
- mlxradiomics-1.0.0/src/mlxradiomics/workflows/reporting.py +265 -0
- mlxradiomics-1.0.0/src/mlxradiomics/workflows/roi.py +340 -0
- mlxradiomics-1.0.0/src/mlxradiomics/workflows/roi_memory.py +74 -0
- mlxradiomics-1.0.0/src/mlxradiomics/workflows/study.py +183 -0
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# MedMLX standard
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*.egg-info/
|
|
5
|
+
.venv
|
|
6
|
+
build/
|
|
7
|
+
dist/
|
|
8
|
+
.pytest_cache/
|
|
9
|
+
.ruff_cache/
|
|
10
|
+
.mypy_cache/
|
|
11
|
+
.hypothesis/
|
|
12
|
+
.coverage
|
|
13
|
+
htmlcov/
|
|
14
|
+
.DS_Store
|
|
15
|
+
# Never commit secrets (Hugging Face tokens)
|
|
16
|
+
.env
|
|
17
|
+
# Never commit data or weights
|
|
18
|
+
/data/
|
|
19
|
+
/work/
|
|
20
|
+
/weights/
|
|
21
|
+
/models/
|
|
22
|
+
/checkpoints/
|
|
23
|
+
/outputs/
|
|
24
|
+
*.nii
|
|
25
|
+
*.nii.gz
|
|
26
|
+
*.dcm
|
|
27
|
+
*.nrrd
|
|
28
|
+
*.mha
|
|
29
|
+
*.mhd
|
|
30
|
+
*.safetensors
|
|
31
|
+
*.pt
|
|
32
|
+
*.pth
|
|
33
|
+
*.ckpt
|
|
34
|
+
*.bin
|
|
35
|
+
*.h5
|
|
36
|
+
*.npy
|
|
37
|
+
*.npz
|
|
38
|
+
# Generated documentation
|
|
39
|
+
/docs/_build/
|
|
40
|
+
/docs/_generated/
|
|
41
|
+
/docs/reference/_autosummary/
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: mlxradiomics
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Extract radiomics features and voxel maps on the Apple Silicon GPU with native MLX
|
|
5
|
+
Project-URL: Homepage, https://medmlx.org
|
|
6
|
+
Project-URL: Documentation, https://github.com/MedMLX/mlx-radiomics/blob/main/README.md
|
|
7
|
+
Project-URL: Repository, https://github.com/MedMLX/mlx-radiomics
|
|
8
|
+
Project-URL: Issues, https://github.com/MedMLX/mlx-radiomics/issues
|
|
9
|
+
Project-URL: MedMLX, https://github.com/MedMLX/medmlx
|
|
10
|
+
Author: Joseph Sandoval, Alfredo Sandoval Jr.
|
|
11
|
+
License-Expression: Apache-2.0 AND MIT AND BSD-3-Clause AND CC-BY-4.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
License-File: THIRD_PARTY_NOTICES.md
|
|
14
|
+
Keywords: apple-silicon,feature-extraction,medical-imaging,metal,mlx,pyradiomics,radiomics
|
|
15
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: Intended Audience :: Science/Research
|
|
18
|
+
Classifier: Operating System :: MacOS :: MacOS X
|
|
19
|
+
Classifier: Programming Language :: Python :: 3
|
|
20
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
23
|
+
Classifier: Topic :: Scientific/Engineering :: Image Processing
|
|
24
|
+
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
|
|
25
|
+
Requires-Python: <3.14,>=3.13
|
|
26
|
+
Requires-Dist: isal<2,>=1.9.1
|
|
27
|
+
Requires-Dist: medmlx-core<0.3,>=0.2.6
|
|
28
|
+
Requires-Dist: mlx==0.32.4; platform_system == 'Darwin' and platform_machine == 'arm64'
|
|
29
|
+
Requires-Dist: nibabel<6,>=5.3
|
|
30
|
+
Requires-Dist: numpy<3,>=2.0
|
|
31
|
+
Requires-Dist: pyyaml<7,>=6
|
|
32
|
+
Requires-Dist: scipy<2,>=1.16.3
|
|
33
|
+
Requires-Dist: simpleitk==2.5.6
|
|
34
|
+
Provides-Extra: lbp
|
|
35
|
+
Requires-Dist: scipy==1.18.1; extra == 'lbp'
|
|
36
|
+
Requires-Dist: trimesh==4.9.0; extra == 'lbp'
|
|
37
|
+
Provides-Extra: viz
|
|
38
|
+
Requires-Dist: matplotlib<4,>=3.10; extra == 'viz'
|
|
39
|
+
Description-Content-Type: text/markdown
|
|
40
|
+
|
|
41
|
+
<div align="center">
|
|
42
|
+
|
|
43
|
+
# mlx-radiomics
|
|
44
|
+
|
|
45
|
+
Extract radiomics features and voxel maps on the Apple Silicon GPU with native MLX.
|
|
46
|
+
|
|
47
|
+
[](https://pypi.org/project/mlxradiomics/)
|
|
48
|
+
[](https://pypi.org/project/mlxradiomics/)
|
|
49
|
+
[](https://github.com/MedMLX/mlx-radiomics/blob/main/LICENSE)
|
|
50
|
+
[](https://github.com/ml-explore/mlx)
|
|
51
|
+
[](https://github.com/MedMLX/medmlx)
|
|
52
|
+
|
|
53
|
+
[Getting started](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/getting-started.md) · [Python API](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/python-api.md) · [Feature catalogue](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/features.md)
|
|
54
|
+
|
|
55
|
+
<img src="https://raw.githubusercontent.com/MedMLX/mlx-radiomics/main/docs/feature-maps.png" alt="CT tumor ROI and six radiomics feature-map overlays" width="100%">
|
|
56
|
+
|
|
57
|
+
</div>
|
|
58
|
+
|
|
59
|
+
| Input | Output |
|
|
60
|
+
| :--- | :--- |
|
|
61
|
+
| Aligned image + integer label mask | ROI features (JSON/CSV) or one float32 NIfTI map per feature |
|
|
62
|
+
|
|
63
|
+
No model weights to download.
|
|
64
|
+
|
|
65
|
+
PyRadiomics feature names and parameter files, with configurable IBSI conventions.
|
|
66
|
+
Requires Apple Silicon with Metal.
|
|
67
|
+
|
|
68
|
+
## Install
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
uv venv --python 3.13
|
|
72
|
+
source .venv/bin/activate
|
|
73
|
+
uv pip install mlxradiomics
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Install `mlxradiomics[lbp]` for LBP3D derived images.
|
|
77
|
+
|
|
78
|
+
Install `mlxradiomics[viz]` for static feature-map figures.
|
|
79
|
+
`mlxradiomics.viz` provides five perceptually uniform palettes with reversed
|
|
80
|
+
variants, ROI overlays, whole-ROI histograms, and PNG/PDF/SVG export. See the
|
|
81
|
+
[visualization guide](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/visualization.md) and
|
|
82
|
+
[runnable example](https://github.com/MedMLX/mlx-radiomics/blob/main/examples/visualize_feature_maps.py).
|
|
83
|
+
|
|
84
|
+
## Python API
|
|
85
|
+
|
|
86
|
+
Start with image and mask files to preserve their physical geometry. Arrays use the
|
|
87
|
+
same settings and result contract:
|
|
88
|
+
|
|
89
|
+
```python
|
|
90
|
+
from mlxradiomics import Settings, extract_files
|
|
91
|
+
|
|
92
|
+
result = extract_files(
|
|
93
|
+
"image.nii.gz", "mask.nii.gz",
|
|
94
|
+
settings=Settings(label=1, bin_width=25, features=("firstorder_Mean", "glcm_Contrast")),
|
|
95
|
+
)
|
|
96
|
+
mean = result.features["original_firstorder_Mean"]
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Add `mode="voxel"` for maps in memory. Use `export_files` to write voxel maps
|
|
100
|
+
without retaining every map in memory. `export` and `export_files` write maps,
|
|
101
|
+
not ROI tables; the file runner below writes ROI JSON/CSV.
|
|
102
|
+
|
|
103
|
+
**Conventions:** defaults follow IBSI, even when using PyRadiomics feature names
|
|
104
|
+
or parameter files. Select alternative definitions through individual `Settings`
|
|
105
|
+
fields.
|
|
106
|
+
|
|
107
|
+
### Arrays and maps
|
|
108
|
+
|
|
109
|
+
```python
|
|
110
|
+
from mlxradiomics import Settings, extract, extract_files, export_files
|
|
111
|
+
|
|
112
|
+
settings = Settings(label=2, features=("firstorder_Mean", "glcm_Contrast"))
|
|
113
|
+
|
|
114
|
+
roi = extract(image, mask, spacing=(3.0, 1.0, 1.0), settings=settings)
|
|
115
|
+
mean = roi.features["original_firstorder_Mean"] # float
|
|
116
|
+
|
|
117
|
+
voxel = extract_files("image.nii.gz", "mask.nii.gz", settings=settings, mode="voxel")
|
|
118
|
+
mean_map = voxel.features["original_firstorder_Mean"] # float64 NumPy array
|
|
119
|
+
|
|
120
|
+
saved = export_files(
|
|
121
|
+
"image.nii.gz", "mask.nii.gz", "outputs/maps", settings=settings,
|
|
122
|
+
)
|
|
123
|
+
saved.report # pathlib.Path to features.json
|
|
124
|
+
saved.maps["original_firstorder_Mean"] # pathlib.Path to a float32 NIfTI
|
|
125
|
+
saved.metadata["settings"] # effective extraction settings
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
| Operation | Arrays | NIfTI/NRRD files | Result |
|
|
129
|
+
| --- | --- | --- | --- |
|
|
130
|
+
| ROI features | `extract(image, mask)` | `extract_files(image_path, mask_path)` | `Result[float]` |
|
|
131
|
+
| Voxel maps in memory | `extract(image, mask, mode="voxel")` | `extract_files(image_path, mask_path, mode="voxel")` | `Result[NDArray[np.float64]]` |
|
|
132
|
+
| Voxel maps on disk | `export(image, mask, output_dir)` | `export_files(image_path, mask_path, output_dir)` | `MapExport(report, maps, metadata)` |
|
|
133
|
+
|
|
134
|
+
Options are keyword-only. Use `settings=` for features and binning,
|
|
135
|
+
`transforms=` for derived images, and `spacing=` for array voxel sizes in
|
|
136
|
+
NumPy axis order. File operations read geometry from the image. Array extraction warns when
|
|
137
|
+
`spacing` is omitted and assumes 1 mm on each axis. Array `export` writes zero
|
|
138
|
+
origin and identity direction; use file operations for scanner-aligned output,
|
|
139
|
+
or explicitly acknowledge synthetic coordinates with `allow_synthetic_geometry=True`.
|
|
140
|
+
|
|
141
|
+
Feature arithmetic is float32. In-memory float64 maps hold those float32 results,
|
|
142
|
+
not higher-precision calculations; saved maps and streamed batches are float32.
|
|
143
|
+
|
|
144
|
+
Extraction results expose `.features` and `.metadata`; exports expose `.report`,
|
|
145
|
+
`.maps` and `.metadata`. The [Python guide](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/python-api.md)
|
|
146
|
+
covers settings, streaming voxel batches and multi-case studies. The
|
|
147
|
+
[visualization guide](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/visualization.md)
|
|
148
|
+
covers figure export.
|
|
149
|
+
|
|
150
|
+
## Parameter files
|
|
151
|
+
|
|
152
|
+
The supported PyRadiomics sections are `setting`, `imageType` and `featureClass`.
|
|
153
|
+
Unsupported keys, image types and per-image overrides raise `InvalidInputError`.
|
|
154
|
+
|
|
155
|
+
```yaml
|
|
156
|
+
setting:
|
|
157
|
+
binWidth: 25
|
|
158
|
+
label: 1
|
|
159
|
+
resampledPixelSpacing: [1.0, 1.0, 1.0]
|
|
160
|
+
interpolator: sitkLinear
|
|
161
|
+
padDistance: 1
|
|
162
|
+
imageType:
|
|
163
|
+
Original: {}
|
|
164
|
+
Wavelet:
|
|
165
|
+
level: 1
|
|
166
|
+
featureClass:
|
|
167
|
+
firstorder: [Mean, Entropy]
|
|
168
|
+
glcm: [Contrast, JointEntropy]
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
`imageType` keys: `Original`, `Square`, `SquareRoot`, `Logarithm`, `Exponential`,
|
|
172
|
+
`Gradient`, `Wavelet`, `LoG`, `LBP2D`, `LBP3D`, `Mean`, `Laws`, `Gabor`,
|
|
173
|
+
`SeparableWavelet`. `Simoncelli` (alias `NonseparableWavelet`) and `Riesz`
|
|
174
|
+
are recognized but cannot run on this release; see [Limits](#limits).
|
|
175
|
+
See [parameter files](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/parameters.md) for filter options and
|
|
176
|
+
[conventions](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/python-api.md#conventions) for definition settings.
|
|
177
|
+
|
|
178
|
+
## Features
|
|
179
|
+
|
|
180
|
+
Use `list_features("firstorder", "glcm")` to select whole families, or
|
|
181
|
+
`list_features(mode="voxel", ndim=3)` to discover names supported in that mode.
|
|
182
|
+
Pass its result as `Settings(features=...)`. Selecting a family does not change
|
|
183
|
+
binning or numerical conventions.
|
|
184
|
+
|
|
185
|
+
`mlxradiomics.FEATURES` lists all 190 names, including all 116 non-deprecated
|
|
186
|
+
PyRadiomics features. Without a `features` selection, extraction returns the 93
|
|
187
|
+
PyRadiomics intensity and texture features; request shape and the other families
|
|
188
|
+
by name.
|
|
189
|
+
|
|
190
|
+
| Family | Count | Modes |
|
|
191
|
+
| --- | ---: | --- |
|
|
192
|
+
| `firstorder` | 21 | ROI, voxel |
|
|
193
|
+
| `intensityhistogram` | 23 | ROI, voxel |
|
|
194
|
+
| `glcm` | 26 | ROI, voxel |
|
|
195
|
+
| `gldm` (NGLDM) | 17 | ROI, voxel |
|
|
196
|
+
| `ngtdm` | 5 | ROI, voxel |
|
|
197
|
+
| `glrlm` | 16 | ROI, voxel |
|
|
198
|
+
| `glszm` | 16 | ROI, voxel |
|
|
199
|
+
| `gldzm` | 16 | ROI, voxel |
|
|
200
|
+
| `ivh` | 7 | ROI, voxel |
|
|
201
|
+
| `localintensity` | 2 | 3D ROI |
|
|
202
|
+
| `shape` | 32 | 3D ROI |
|
|
203
|
+
| `shape2D` | 9 | 2D ROI, or one slice of a 3D ROI |
|
|
204
|
+
|
|
205
|
+
Calculation conventions such as kurtosis, shape covariance divisor, NGTDM
|
|
206
|
+
singular cases and fixed-bin-size origin are independent `Settings` fields with
|
|
207
|
+
IBSI defaults. Select each alternative explicitly; see
|
|
208
|
+
[Conventions](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/python-api.md#conventions).
|
|
209
|
+
The [feature catalogue](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/features.md#catalogue) lists public names and
|
|
210
|
+
their IBSI identifiers.
|
|
211
|
+
|
|
212
|
+
## MedMLX and automation
|
|
213
|
+
|
|
214
|
+
The [MedMLX MCP server](https://github.com/MedMLX/medmlx/blob/main/docs/mcp.md) installs this runtime and lets an AI agent describe, check and run `mlxradiomics`.
|
|
215
|
+
|
|
216
|
+
```sh
|
|
217
|
+
uv tool install --python 3.13 "medmlx[vision,mcp]"
|
|
218
|
+
MEDMLX="$(uv tool dir --bin --color never)/medmlx"
|
|
219
|
+
mkdir -p "$HOME/medmlx-work"
|
|
220
|
+
claude mcp add --scope user medmlx -- "$MEDMLX" serve --root "$HOME/medmlx-work"
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
For Codex, use `codex mcp add medmlx -- "$MEDMLX" serve --root "$HOME/medmlx-work"`. Other MCP clients take the same command and arguments. The same install provides the `medmlx` CLI, for example `medmlx describe mlxradiomics`.
|
|
224
|
+
|
|
225
|
+
The MCP `run_model` tool takes the arguments of `mlxradiomics.medmlx.run` below.
|
|
226
|
+
|
|
227
|
+
### File runner
|
|
228
|
+
|
|
229
|
+
```python
|
|
230
|
+
from mlxradiomics.medmlx import run
|
|
231
|
+
|
|
232
|
+
result = run(image_path="image.nii.gz", mask_path="mask.nii.gz", output_dir="features")
|
|
233
|
+
result["files"]["features_json"] # path to the report
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### Inputs and outputs
|
|
237
|
+
|
|
238
|
+
Use a 2D or 3D NIfTI/NRRD image and an integer label mask on the same grid.
|
|
239
|
+
`label` defaults to 1. ROI mode writes `features.json` and `features.csv`;
|
|
240
|
+
`voxel=True` writes float32 NIfTI maps under `maps/`, zero outside the ROI.
|
|
241
|
+
Set `overwrite=True` to replace existing outputs.
|
|
242
|
+
|
|
243
|
+
Feature keys include image, family and name, such as `original_glcm_Contrast`.
|
|
244
|
+
The result contains `outputs`, `files` and `details`. See the
|
|
245
|
+
[runner guide](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/runner.md)
|
|
246
|
+
for all arguments, report fields, geometry and error handling.
|
|
247
|
+
|
|
248
|
+
## Limits
|
|
249
|
+
|
|
250
|
+
- Shape and local intensity are ROI-only; local intensity needs 3D input.
|
|
251
|
+
- Simoncelli and Riesz filters are unavailable on this release; see the limits guide.
|
|
252
|
+
- Feature arithmetic is float32. Undefined values are NaN; overflow is infinity.
|
|
253
|
+
- Read voxel maps with NiBabel; SimpleITK reads stored NaN voxels as zero.
|
|
254
|
+
- Detached inputs such as `.nhdr` require a new output directory, even with
|
|
255
|
+
`overwrite=True`.
|
|
256
|
+
|
|
257
|
+
See [limits](https://github.com/MedMLX/mlx-radiomics/blob/main/docs/guide/limits.md)
|
|
258
|
+
for filter requirements and supported inputs, and the
|
|
259
|
+
[environment guide](https://github.com/MedMLX/mlx-radiomics/blob/main/environment/README.md)
|
|
260
|
+
for development.
|
|
261
|
+
|
|
262
|
+
## License
|
|
263
|
+
|
|
264
|
+
[Apache-2.0](https://github.com/MedMLX/mlx-radiomics/blob/main/LICENSE). See [third-party notices](https://github.com/MedMLX/mlx-radiomics/blob/main/THIRD_PARTY_NOTICES.md), including CC BY 4.0 attribution
|
|
265
|
+
for adapted IBSI manifest definitions.
|