The bonndit package contains the latest diffusion imaging tools developed at the University of Bonn.
The bonndit package contains the latest diffusion imaging tools developed at the University of Bonn. This early release focuses on our framework for single and multi tissue deconvolution using constrained higher-order tensor fODFs. In addition, it includes code for fitting the Diffusional Kurtosis (DKI) model. More will follow as time permits.
- Free software: GNU General Public License v3
- Documentation: https://bonndit.readthedocs.io.
To install bonndit, run the following command
$ pip install bonndit
stdeconv: Script to calculate white matter response function and fiber orientation distribution functions (fODFs) from a single shell diffusion signal.
mtdeconv: Script to calculate multi tissue response functions and fiber orientation distribution functions (fODFs) from multi shell or DSI signals.
kurtosis: Script to fit a kurtosis model using quadratic cone programming to guarantee a minimum diffusivity. It also calculates kurtosis measures based on the fitted model.
- All functionality implemented in an object oriented manner.
- Multiprocessing support implemented in the underlying infrastructure for faster computations
- Logs written to your output directory
For calculating the multi-tissue response functions and the fODFs for given data run the following command:
$ mtdeconv -i /path/to/your/data --verbose True
The specified folder should contain the following files:
data.nii.gz: The diffusion weighted data
dti_FA.nii.gz: Diffusion tensor Fractional Anisotropy map
fast_pve_0.nii.gz: CSF mask
fast_pve_1.nii.gz: GM mask
fast_pve_2.nii.gz: WM mask
dti_V1.nii.gz: The first eigenvector of the diffusion tensor
dti_* files can be generated using FSL’s
fast_* files can be generated from coregistered T1 weighted images using FSL’s
Optional, but recommended to greatly speed up computation:
mask.nii.gz: Binary mask, specifying brain voxels in which to estimate the model
If you want to see a list of parameters type the following:
$ mtdeconv -h
If you use our software as part of a scientific project, please cite the corresponding publications. The method implemented in
mtdeconv was first introduced in
- Michael Ankele, Lek-Heng Lim, Samuel Groeschel, Thomas Schultz: Fast and Accurate Multi-Tissue Deconvolution Using SHORE and H-psd Tensors. In: Proc. Medical Image Analysis and Computer-Aided Intervention (MICCAI) Part III, pp. 502-510, vol. 9902 of LNCS, Springer, 2016
It was refined and extended in
- Michael Ankele, Lek-Heng Lim, Samuel Groeschel, Thomas Schultz: Versatile, Robust, and Efficient Tractography With Constrained Higher-Order Tensor fODFs. In: Int’l J. of Computer Assisted Radiology and Surgery, 12(8):1257-1270, 2017
The use of quadratic cone programming to make the kurtosis fit more stable which is implemented in
kurtosis has been explained in the methods section of
- Samuel Groeschel, G. E. Hagberg, T. Schultz, D. Z. Balla, U. Klose, T.-K. Hauser, T. Nägele, O. Bieri, T. Prasloski, A. MacKay, I. Krägeloh-Mann, K. Scheffler: Assessing white matter microstructure in brain regions with different myelin architecture using MRI. In: PLOS ONE 11(11):e0167274, 2016
PDFs can be obtained from the respective publisher, or the academic homepage of Thomas Schultz: http://cg.cs.uni-bonn.de/en/people/prof-dr-thomas-schultz/
- ‘mtdeconv’: If response is available, files needed for the computation of the response are not loaded.
- First release on PyPI.
- Making repository public on Github
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size bonndit-0.1.2-py3-none-any.whl (64.1 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size bonndit-0.1.2.tar.gz (155.1 kB)||File type Source||Python version None||Upload date||Hashes View|