Skip to main content

Automatic DTI-ALPS ROI detection and analysis

Project description

autoDTI-ALPS

Automated DTI-ALPS (Diffusion Tensor Imaging Along the Perivascular Space) analysis tool. Uses template-based registration to place ROIs in projection and association fiber regions, then calculates the DTI-ALPS index from diffusion tensor imaging data.

Dependencies

Python

Requires Python 3.10+.

Core dependencies (installed automatically):

Optional GUI dependencies (pip install -e ".[gui]"):

External Neuroimaging Software

The following third-party programs must be installed and available on your system PATH.

MRtrix3 (required)

MRtrix3 provides tools for diffusion MRI preprocessing and tensor fitting.

Command Pipeline Stage Purpose
dwidenoise Denoising Marchenko-Pastur PCA thermal noise removal
mrdegibbs Gibbs Removal Gibbs ringing artifact correction
dwifslpreproc Preprocessing Eddy current, motion, and distortion correction
dwi2tensor Tensor Fitting Fit diffusion tensor model to DWI data
tensor2metric Metric Extraction Extract FA, eigenvectors (V1-V3), and eigenvalues (L1-L3)
dwi2mask Preprocessing Brain mask generation from DWI
dwiextract B0 Extraction Extract b=0 volumes from DWI
mrmath B0 Extraction Average multiple b=0 volumes
mrconvert Format Conversion Image format conversion and header manipulation

Installation: https://www.mrtrix.org/download/

FSL (required)

FSL provides tools for brain extraction, registration, and image manipulation.

Command Pipeline Stage Purpose
flirt Registration Linear (affine) FA-to-template registration
fnirt Registration Non-linear FA-to-template registration
invwarp Registration Generate inverse warp field for ROI transformation
applywarp ROI Placement Transform ROI templates from standard to native space
fslmaths Masking Apply brain mask to FA image
eddy Preprocessing Eddy current and motion correction
topup Preprocessing Susceptibility-induced distortion field estimation
applytopup Preprocessing Apply topup distortion correction

Installation: https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FslInstallation

Installation

Whichever route you choose, MRtrix3 and FSL are not bundled and must be installed separately and on your PATH (see External Neuroimaging Software).

Install with pipx (recommended)

If you have Python 3.10+, pipx installs the app into an isolated environment and puts the dti-alps command on your PATH:

pipx install dti-alps
dti-alps            # launch the GUI

Update with pipx upgrade dti-alps. (Plain pip install dti-alps also works, ideally inside a virtualenv, and provides the same dti-alps command.)

Download the AppImage (no Python needed)

For double-click file with no Python setup, grab the latest Linux AppImage from the Releases page:

chmod +x dti-alps-*-x86_64.AppImage
./dti-alps-0.1.0-x86_64.AppImage

The AppImage bundles the app and its Python dependencies. To update, download the newer AppImage and replace the old file.

Qt runtime note: the GUI uses Qt 6, which needs libxcb-cursor0 on the host. If the app fails to start with an xcb platform-plugin error, install it: sudo apt install libxcb-cursor0 (Debian/Ubuntu).

From source (development)

pip install -e ".[gui]"

Usage

dti-alps                    # Launch GUI (default)
dti-alps --viewer           # Launch Results Viewer
dti-alps --viewer /path     # Launch viewer with specific output folder
dti-alps --report /path     # Generate quality reports
dti-alps --reanalyze /path --sphere 3  # Reanalyze with different ROI shapes

When running the AppImage, substitute ./dti-alps-*.AppImage for dti-alps; all CLI flags are forwarded (e.g. ./dti-alps-*.AppImage --viewer /path).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dti_alps-0.1.0.tar.gz (184.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dti_alps-0.1.0-py3-none-any.whl (143.4 kB view details)

Uploaded Python 3

File details

Details for the file dti_alps-0.1.0.tar.gz.

File metadata

  • Download URL: dti_alps-0.1.0.tar.gz
  • Upload date:
  • Size: 184.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dti_alps-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ac5323205856d24c9b1b68b43aaa6c6a91269aa06fe9ddf9c4a53d6bb295d8e3
MD5 15a01d4dbdfbceb51107bf284f4e5a5c
BLAKE2b-256 1e3746eb10766b0eb2f1dc9b854406b4221b0249a6bd9a5a587125db1ba1f716

See more details on using hashes here.

Provenance

The following attestation bundles were made for dti_alps-0.1.0.tar.gz:

Publisher: publish.yml on rmoskwa/auto-DTI-ALPS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dti_alps-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: dti_alps-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 143.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dti_alps-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 70f6107774f34a55308e23cf9dfe4e5d7ff74a1db0433d5c67c6ba6fc0b7c143
MD5 4577e42411f286d758d1da3d67a4155b
BLAKE2b-256 74058f9971e4e4385b2f714c1b6c92497457c374524ef8ed92c0c3ff726036ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for dti_alps-0.1.0-py3-none-any.whl:

Publisher: publish.yml on rmoskwa/auto-DTI-ALPS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page