dmri-commit 2.1.0__tar.gz → 2.2.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 (38) hide show
  1. dmri-commit-2.2.0/MANIFEST.in +4 -0
  2. dmri-commit-2.2.0/PKG-INFO +159 -0
  3. dmri-commit-2.2.0/commit/__init__.py +10 -0
  4. dmri-commit-2.2.0/commit/core.pyx +1641 -0
  5. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/models.py +18 -7
  6. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/operator/operator.pyx +3 -3
  7. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/proximals.pyx +7 -16
  8. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/solvers.py +76 -45
  9. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/trk2dictionary/trk2dictionary.pyx +194 -168
  10. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/trk2dictionary/trk2dictionary_c.cpp +22 -21
  11. dmri-commit-2.2.0/dmri_commit.egg-info/PKG-INFO +159 -0
  12. {dmri-commit-2.1.0/build → dmri-commit-2.2.0}/dmri_commit.egg-info/SOURCES.txt +8 -10
  13. dmri-commit-2.2.0/dmri_commit.egg-info/requires.txt +4 -0
  14. dmri-commit-2.2.0/pyproject.toml +64 -0
  15. dmri-commit-2.2.0/setup.cfg +4 -0
  16. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/setup.py +5 -20
  17. dmri-commit-2.2.0/tests/test_demo.py +165 -0
  18. dmri-commit-2.1.0/MANIFEST.in +0 -7
  19. dmri-commit-2.1.0/PKG-INFO +0 -28
  20. dmri-commit-2.1.0/build/dmri_commit.egg-info/PKG-INFO +0 -28
  21. dmri-commit-2.1.0/build/dmri_commit.egg-info/requires.txt +0 -7
  22. dmri-commit-2.1.0/commit/__init__.py +0 -3
  23. dmri-commit-2.1.0/commit/core.cpp +0 -56282
  24. dmri-commit-2.1.0/commit/core.pyx +0 -1374
  25. dmri-commit-2.1.0/commit/info.py +0 -33
  26. dmri-commit-2.1.0/commit/trk2dictionary/trk2dictionary.cpp +0 -33264
  27. dmri-commit-2.1.0/setup.cfg +0 -12
  28. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/LICENSE +0 -0
  29. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/README.md +0 -0
  30. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/operator/__init__.py +0 -0
  31. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/operator/config.py +0 -0
  32. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/operator/operator.pyxbld +0 -0
  33. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/operator/operator_noLUT.c +0 -0
  34. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/operator/operator_withLUT.c +0 -0
  35. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/trk2dictionary/ProgressBar.h +0 -0
  36. {dmri-commit-2.1.0 → dmri-commit-2.2.0}/commit/trk2dictionary/Vector.h +0 -0
  37. {dmri-commit-2.1.0/build → dmri-commit-2.2.0}/dmri_commit.egg-info/dependency_links.txt +0 -0
  38. {dmri-commit-2.1.0/build → dmri-commit-2.2.0}/dmri_commit.egg-info/top_level.txt +0 -0
@@ -0,0 +1,4 @@
1
+ recursive-include commit *.c
2
+ recursive-include commit *.cpp
3
+ recursive-include commit *.h
4
+ recursive-include commit *pyx
@@ -0,0 +1,159 @@
1
+ Metadata-Version: 2.1
2
+ Name: dmri-commit
3
+ Version: 2.2.0
4
+ Summary: Convex Optimization Modeling for Microstructure Informed Tractography (COMMIT)
5
+ Author-email: Alessandro Daducci <alessandro.daducci@univr.it>
6
+ Maintainer-email: DICE lab <DICE_lab@strutture.univr.it>
7
+ License: ################################################################################
8
+ COMMIT software license agreement
9
+ Version 2, 24 July 2023
10
+ ################################################################################
11
+
12
+ ------------------------------------PREAMBLE------------------------------------
13
+ This license agreement (“Agreement”) is a legal agreement between you and the
14
+ Diffusion Imaging and Connectivity Estimation laboratory (“DICE lab”) for the
15
+ use of the COMMIT software (“Software”). By downloading and/or using the
16
+ Software, you hereby accept and agree to all the terms and conditions of this
17
+ Agreement. As used in this Agreement, “you” refers to any individual or
18
+ organization that uses the Software.
19
+
20
+
21
+ ------------------------------TERMS AND CONDITIONS------------------------------
22
+ [1] License Grant
23
+ Subject to all the terms and conditions of this Agreement, the DICE lab hereby
24
+ grants you a worldwide, non-exclusive, non-transferable, limited license to
25
+ copy, use, modify, and redistribute the Software solely for research and
26
+ educational purposes, free of charge.
27
+
28
+ [2] Commercial use
29
+ You may not use the Software and/or any work based on or using the Software for
30
+ any commercial purpose, including but not limited to selling, licensing,
31
+ distributing, renting, or leasing the Software for profit. If you want to use
32
+ the Software for commercial purposes, you may contact the DICE lab to obtain a
33
+ commercial license agreement. The DICE lab may consider offering a commercial
34
+ license, subject to negotiation of appropriate terms and conditions, including
35
+ but not limited to the payment of a license fee and compliance with any
36
+ additional restriction on the use of the Software.
37
+
38
+ [3] Attributions and Acknowledgments
39
+ You agree to provide an acknowledgement identifying the Software and referencing
40
+ its use in any publication, presentation, research result, and product related
41
+ to or arising from the use of the Software. You also agree to give proper
42
+ attribution to the original Software and reproduce this Agreement in any
43
+ modified and/or redistributed work based on the Software.
44
+
45
+ [4] Patents
46
+ If you plan to file a patent application based on or using the Software, you
47
+ must contact the DICE lab. The DICE lab may have certain rights or restrictions
48
+ related to such patents that need to be addressed before filing the application.
49
+
50
+ [5] Compliance with Law
51
+ In exercising your rights under this Agreement, you agree to comply with all
52
+ applicable governmental laws and regulations, including but not limited to the
53
+ use, export, and transmission of the Software. You are solely responsible for
54
+ ensuring that your use of the Software complies with such laws and regulations.
55
+ The DICE lab is not responsible for any violations of such laws or regulations
56
+ by you.
57
+
58
+ [6] Warranty
59
+ The Software is provided "AS IS" without warranty of any kind, express or
60
+ implied, including but not limited to the warranties of merchantability, fitness
61
+ for a particular purpose and non-infringement of third-party rights. The
62
+ Software may also contain errors and is subject to further development and
63
+ revision. The DICE lab does not guarantee the accuracy of the Software or any
64
+ result or data arising from the use of the Software.
65
+
66
+ [7] Disclaimers
67
+ The Software has been designed for research purposes only and has not been
68
+ reviewed or approved by the Food and Drug Administration or by any other agency.
69
+ You acknowledge and agree that clinical applications are neither recommended nor
70
+ advised.
71
+
72
+ [8] Limitation of Liability
73
+ In no event shall the DICE lab be liable to any party for any direct, indirect,
74
+ special, incidental, exemplary, or consequential damages, however caused and
75
+ under any theory of liability, arising in any way related to the Software, even
76
+ if the DICE lab has been advised of the possibility of such damages. Except to
77
+ the extent prohibited by law or regulation, you assume all risk and liability
78
+ for your use of the Software. You also agree to indemnify and hold harmless the
79
+ DICE lab from and against all claims, suits, actions, demands, and judgments
80
+ arising from your use or misuse of the Software.
81
+
82
+
83
+ ------------------------------------CONTACT-------------------------------------
84
+ If you have any question about the terms of this Agreement, you may contact the
85
+ head of the DICE lab Alessandro Daducci at alessandro.daducci@univr.it
86
+
87
+ Project-URL: Homepage, https://github.com/daducci/COMMIT.git
88
+ Project-URL: Documentation, https://github.com/daducci/COMMIT/wiki
89
+ Project-URL: Repository, https://github.com/daducci/COMMIT.git
90
+ Project-URL: Issues, https://github.com/daducci/COMMIT/issues
91
+ Project-URL: Changelog, https://github.com/daducci/COMMIT/blob/master/CHANGELOG.md
92
+ Keywords: Neuroimaging
93
+ Classifier: Intended Audience :: Science/Research
94
+ Classifier: License :: Other/Proprietary License
95
+ Classifier: Programming Language :: C++
96
+ Classifier: Programming Language :: Cython
97
+ Classifier: Programming Language :: Python :: 3
98
+ Classifier: Programming Language :: Python :: 3 :: Only
99
+ Classifier: Programming Language :: Python :: 3.8
100
+ Classifier: Programming Language :: Python :: 3.9
101
+ Classifier: Programming Language :: Python :: 3.10
102
+ Classifier: Programming Language :: Python :: 3.11
103
+ Classifier: Programming Language :: Python :: 3.12
104
+ Requires-Python: >=3.8
105
+ Description-Content-Type: text/markdown
106
+ License-File: LICENSE
107
+ Requires-Dist: dmri-amico>=2.0.1
108
+ Requires-Dist: dmri-dicelib>=1.1.0
109
+ Requires-Dist: numpy>=1.24.4
110
+ Requires-Dist: scipy>=1.10.1
111
+
112
+ [![PyPI](https://img.shields.io/pypi/v/dmri-commit)](https://pypi.org/project/dmri-commit/)
113
+ [![PyPI - Downloads](https://img.shields.io/pypi/dm/dmri-commit)](#)
114
+ [![LICENSE](https://img.shields.io/github/license/daducci/commit)](https://github.com/daducci/COMMIT/blob/master/LICENSE)
115
+ [![GitHub top language](https://img.shields.io/github/languages/top/daducci/commit?color=lightgray)](#)
116
+ [![reference](https://img.shields.io/badge/DOI-10.1109/TMI.2014.2352414-red.svg)](https://ieeexplore.ieee.org/document/6884830)
117
+
118
+ [![GitHub stars](https://img.shields.io/github/stars/daducci/COMMIT?style=social)](#)
119
+ [![GitHub forks](https://img.shields.io/github/forks/daducci/COMMIT?style=social)](#)
120
+ [![GitHub watchers](https://img.shields.io/github/watchers/daducci/COMMIT?style=social)](#)
121
+ [![GitHub followers](https://img.shields.io/github/followers/daducci?style=social)](#)
122
+ [![GitHub contributors](https://img.shields.io/github/contributors-anon/daducci/COMMIT?style=social)](#)
123
+ [![Twitter Follow](https://img.shields.io/twitter/follow/ADaducci)](https://twitter.com/intent/follow?screen_name=ADaducci)
124
+
125
+ # COMMIT
126
+
127
+ The reconstructions recovered with existing tractography algorithms are not really quantitative even though diffusion MRI is a quantitative modality. COMMIT stands for *Convex Optimization for Microstructure Informed Tractography* and is a **powerful framework for enhancing the anatomical accuracy of the reconstructions** by combining tractography with microstructural features of the neuronal tissue.
128
+
129
+ <img align="right" src="https://github.com/daducci/COMMIT/wiki/images/filtering_methods.png" height="225">
130
+
131
+ **How?** Starting from an input set of candidate fiber-tracts estimated using standard fiber-tracking techniques, COMMIT models the diffusion MRI signal in each voxel of the image as a *linear combination* of the restricted and hindered contributions generated in every location of the brain by these candidate tracts. Then, COMMIT seeks for the effective contribution of each of them such that they globally fit the measured signal at best.
132
+ These weights can be *efficiently estimated by solving a convenient linear system*.
133
+
134
+ Results clearly demonstrated the benefits of the proposed formulation, opening new perspectives for a more quantitative and biologically-plausible assessment of the structural connectivity of the brain. See the [references](https://github.com/daducci/COMMIT/wiki/References) for more information.
135
+
136
+ <p align="center">
137
+ <img src="https://github.com/daducci/COMMIT/wiki/images/COMMIT_example.png" height="450">
138
+ </p>
139
+
140
+ ## Main features
141
+
142
+ - Very efficient: COMMIT is implemented in Python but the core of the algorithm is implemented in C++ and using **multi-thread programming** for efficient parallel computation.
143
+ - Accepts and works with **any input tractogram** (i.e. set of fiber tracts).
144
+ - Can easily implement and consider **any multi-compartment model** available in the literature: possibility to account for restricted, hindered as well as isotropic contributions into the signal forward model.
145
+ - **Low memory** consumption using optimized sparse data structures, e.g. it can easily run on a standard laptop with 8GB RAM a full-brain tractogram from the HCP data (1M fibers, 3 shells, 1.25 mm^3 resolution).
146
+ - **Soon**: **GPU implementation** for even faster model fitting.
147
+
148
+
149
+ ## Documentation
150
+
151
+ More information/documentation, as well as a series of tutorials, can be found in the [wiki pages](https://github.com/daducci/COMMIT/wiki/Home).
152
+
153
+ ### Installation
154
+ To install COMMIT, refer to the [installation guide](https://github.com/daducci/COMMIT/wiki/Installation).
155
+
156
+ ### Getting started
157
+
158
+ To get started with the COMMIT framework, have a look at [this tutorial](https://github.com/daducci/COMMIT/wiki/Getting-started), which will guide you through the main steps of the processing.
159
+
@@ -0,0 +1,10 @@
1
+ from importlib import metadata
2
+
3
+ from .core import Evaluation, setup
4
+
5
+ __all__ = ['core','models','solvers','trk2dictionary']
6
+
7
+ try:
8
+ __version__ = metadata.version('dmri-commit')
9
+ except metadata.PackageNotFoundError:
10
+ __version__ = 'not installed'