Skip to main content

SANDI python toolbox

A BIDS app for fitting the Soma and Neurite Density Imaging (SANDI) model, adapted from the SANDI Matlab Toolbox by Marco Palombo into python using snakebids.

This toolbox enables model-based estimation of MR signal fraction of brain cell bodies (of all cell types, from neurons to glia, namely soma) and cell projections (of all cell types, from dentrites and myelinated axons to glial processes, namely neurties ) as well as apparent MR cell body radius and intraneurite and extracellular apparent diffusivities from a suitable diffusion-weighted MRI acquisition using Machine Learning (see the original SANDI paper for more details DOI: https://doi.org/10.1016/j.neuroimage.2020.116835).

Installation

Dependency management and python package handling is done with poetry

pip install poetry

then the toolbox can be installed with:

git clone https://github.com/Bradley-Karat/SANDI_python_toolbox.git
cd SANDI_python_toolbox
poetry install

Usage

poetry run SANDI_python_toolbox

or

poetry shell
SANDI_python_toolbox

Run either of these with the -h flag to get a detailed summary of the toolbox and its flags plus required arguments.

Example Toolbox Call

For a dry-run:

poetry run SANDI_python_toolbox /path/to/bids/inputs /path/for/outputs participant --Delta 23.6 --Small_Delta 7 --cores all -np

To actually run the software:

poetry run SANDI_python_toolbox /path/to/bids/inputs /path/for/outputs participant --Delta 23.6 --Small_Delta 7 --cores all

Example File Struture

└── bids
    ├── sub-01
    │ └── dwi
    │     ├── sub-01_brain_mask.nii.gz
    │     ├── sub-01_dwi.bval
    │     ├── sub-01_dwi.bvec
    │     ├── sub-01_dwi.nii.gz
    │     └── sub-01_noisemap.nii.gz
    ├── sub-02
    │ └── dwi
    │     ├── sub-02_brain_mask.nii.gz
    │     ├── sub-02_dwi.bval
    │     ├── sub-02_dwi.bvec
    │     ├── sub-02_dwi.nii.gz
    │     └── sub-02_noisemap.nii.gz

Alternatively, the --path-dwi flag can be used to override BIDS by specifying absolute paths. For example: --path-dwi /path/to/my_data/{subject}/dwi.nii.gz. The other necessary files (.bval, .bvec, noisemap and brainmask) must be labelled in a similar fashion (i.e. all have the same prefix).

Metadata

Release files for sandi-python-toolbox 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sandi-python-toolbox 0.1.2
File Size Uploaded
sandi_python_toolbox-0.1.2.tar.gz 31.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sandi-python-toolbox 0.1.2
File Interpreter ABI Platform
sandi_python_toolbox-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 66.5 kB

Release files / sandi_python_toolbox-0.1.2.tar.gz

Download URL sandi_python_toolbox-0.1.2.tar.gz
Size 31.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5fbf3300843ef32f697029a216a7551ff97000069fdf84823927182817a68194
BLAKE2b-256 checksum
How to use checksums
54ea69091a5831d7de3ca60c0182a456ab5604fe1fe767a8638793c1a7041324
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.10.2 Linux/3.10.0-1160.88.1.el7.x86_64

Release files / sandi_python_toolbox-0.1.2-py3-none-any.whl

Download URL sandi_python_toolbox-0.1.2-py3-none-any.whl
Size 34.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
815b9111811540b8f4417c0cf2c5f1cc52937d9ea01d007257fd56bb88c5e111
BLAKE2b-256 checksum
How to use checksums
3013d60481a015f2b28f4c8abe749fe1687f38b3f11e1b2ae605275b997e9d9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.10.2 Linux/3.10.0-1160.88.1.el7.x86_64

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page