SlicerDSpace
Film
Native diffusion space
Outputs from SlicerDSpace.
Representative maps, surfaces, pathways and networks from the available analysis routes. Each view highlights a different product in native diffusion space.
Get started
From installation to your first result.
Install, run and review with your Agent. (Recommended)
-
Read the Skill
We provide an install-and-use Skill for SlicerDSpace. Give its SKILL.md to your local Agent to follow the project's setup, analysis and result-review workflow.
The prompts link to SKILL.md as the entry point. To install the Skill in your Agent, copy the complete slicerdspace folder with its references, scripts and templates.
-
Install and enable
Agent promptRead https://github.com/NeuroDMRI/SlicerDSpace/blob/main/.agents/skills/slicerdspace/SKILL.md. Install and enable SlicerDSpace in my local 3D Slicer. Set up the required dependencies and download the corresponding model weights.Your Agent checks storage space and existing resources, waits for your choice and saves the path for later use. It prepares only the selected analyses. Confirm licenses and restarts when requested.
-
Use an existing installation
Replace the input and output paths, and choose the methods your study needs. This example requests DDParcel, CSD/ACT tractography and a structural connectome.
Analysis promptRead https://github.com/NeuroDMRI/SlicerDSpace/blob/main/.agents/skills/slicerdspace/SKILL.md. Use SlicerDSpace to run DDParcel brain parcellation, CSD/ACT tractography and structural connectome construction for /path/to/subject; save results to /path/to/results. Show me the plan and wait for confirmation before running. Afterwards, summarize the outputs and QC findings.
Or set up manually
-
Install the module
Start with 3D Slicer; the protocol reference is version 5.10. Clone the source and create a separate extension installation:
bashgit clone https://github.com/NeuroDMRI/SlicerDSpace.git cd SlicerDSpace python3 scripts/stage_slicer_extension.py \ --install-root ~/SlicerDSpace-extension --slicer-version 5.10 \ --link-mode copyReplace
5.10with the major/minor version shown in Slicer’s About dialog. The script stages the module and reports its installation directory. -
Add the module path
Open Edit › Application Settings › Modules › Additional module paths. Add the expanded absolute path of
~/SlicerDSpace-extension/SlicerDSpace/lib/Slicer-5.10/qt-scripted-modules, matching the version you staged.Install SlicerDMRI and PyTorch from Slicer’s Extension Manager. Add the separate UKFTractography extension if you plan to use UKF. Restart Slicer, then open Modules › Diffusion › SlicerDSpace.
-
Prepare the subject inputs
Enter a Subject ID and Subject root. For prepared inputs, use this layout; the output directory can remain empty to use the subject’s
outputs/folder.sub-01/ input/ data.nii.gz bvals bvecs nodif_brain_mask.nii.gz # optional; supply or generateDWI and mask must share one voxel grid. The gradient count must match the DWI volume count, and motion-corrected images need the corresponding rotated gradients.
For DICOM or NRRD/NHDR, use Advanced settings › Regions & input import › Input import / conversion. Preview the import, then prepare the inputs before analysis.
-
Select methods and prepare their environment
For a small first run, select only Microstructure, clear the other products and keep DTI in its ... selector. For a fuller route, choose one or several algorithms beside each product. Advanced settings contains the model and tracking parameters.
Open Environment and installation › Prepare selected analysis environment. Confirm the required tools, models and resource terms. Downloads are checked and cached for reuse. If a restart is requested, restart and select Prepare again to continue.
Offline model resources, repair and manual path overrides are under More options. An existing reviewed mask avoids installing a mask-generation backend for the DTI-only route.
-
Run and inspect
Click Run SlicerDSpace. Missing fields are highlighted, and the log reports progress or a specific correction. Successful key products load automatically; DTI supplies FA and MD for inspection.
In Results and QC, select the run to inspect its checks and reload or replace products without duplicating scene nodes. Review mask coverage, alignment and method-specific QC before accepting results.
Command-line execution and cohort processing
From the checkout, use Slicer’s Python to check a DTI-only route. Replace the two absolute paths below:
export SLICER_LAUNCHER="/path/to/Slicer"
export SUBJECT_ROOT="/path/to/sub-01"
"$SLICER_LAUNCHER" --launch PythonSlicer run_subject_pipeline.py \
--subject-root "$SUBJECT_ROOT" --subject-id sub-01 --no-user-config \
--targets microstructure --microstructure-stages dti --doctor
Repeat with --plan to inspect the processing plan, then --execute to run it. Keep the same method options for all three commands.
For example, --microstructure-stages dti,noddi selects two models; --tractography-backend csd_act,ukf selects two tracking variants; and --bundle-backend wmql,wma selects two bundle methods. Their input and dependency checks still apply.
For independent subjects, use scripts/run_batch_pipeline.py --batch-root /path/to/study --jobs 2 with your chosen analysis options. The GUI processes the current subject; the batch CLI manages separate outputs and logs.
Run times
Recorded run times, per module.
Performance
Runtime optimizations.
Measured comparisons for each operation, with its scope and implementation details.
Catalogue updated 30 October 2026
Download measurement data (JSON)| Computation / scope | Type of change | Reference | Optimized | Measured ratio |
|---|---|---|---|---|
| Full brain / record 2026-10-29 | Same-method implementation | 15.64 min | 11.89 min | 1.32x23.99% less time |
| ||||
| Complete module / record 2026-10-20 | Same-method implementation | 102.10 min | 74.22 min | 1.38x27.31% less time |
| ||||
| Full brain / record 2026-10-20 | Native threads | 29.15 min | 5.19 min | 5.61x82.19% less time |
| ||||
| 64-voxel numeric chunk / record 2026-10-22 | Python-port computation | 1.73 s | 1.09 s | 1.58x36.70% less time |
| ||||
| 64-voxel numeric chunk / incremental QR change / record 2026-10-29 | Python-port computation | 1.19 s | 1.06 s | 1.13x11.26% less time |
| ||||
| Native 24-cubed ROI / record 2026-10-22 | Existing upstream capability | 37.11 s | 11.47 s | 3.24x69.09% less time |
| ||||
| Native 24-cubed ROI / record 2026-10-20 | Workflow scheduling | 43.95 s | 24.63 s | 1.78x43.96% less time |
| ||||
| Single substage / record 2026-10-20 | Same-method implementation | 134.29 s | 2.48 s | 54.06x98.15% less time |
| ||||
| 1728-voxel ROI / record 2026-10-21 | Same-method implementation | 12.47 s | 5.17 s | 2.41x58.50% less time |
| ||||
| 1000 fibers x 15 points / record 2026-10-21 | Same-method implementation | 24.6 ms | 0.322 ms | 76.31x98.69% less time |
| ||||
| 20000 fibers x 15 points / record 2026-10-21 | Same-method implementation | 0.59 s | 12.8 ms | 45.84x97.82% less time |
| ||||
| Three preparation calls / record 2026-10-20 | Same-method implementation | 8.90 min | 3.01 min | 2.96x66.17% less time |
| ||||
| Four left-hemisphere overlays / record 2026-10-20 | Inherited upstream optimization | 13.38 s | 3.52 s | 3.80x73.70% less time |
| ||||
| Three slabs / record 2026-10-20 | Compressed data I/O | 37.25 s | 17.08 s | 2.18x54.15% less time |
| ||||
Methods & resources
What is integrated
Choose one or several methods beside each product. The workflow checks acquisition suitability, resolves dependencies and reuses shared preparation.
| Stage | Method | How it is integrated | Runtime / access | Papers |
|---|---|---|---|---|
| Input | DICOM / NIfTI / NRRD | Conversion, gradient validation and spatial checks. | dcm2niix or Slicer DWIConvert; supplied masks accepted | [36] [27] [28] |
| Brain mask | PNL CNN (default) | Author diffusion-CNN brain masking and registration. | Managed PNL runtime, weights and ANTs | [37] [38] |
| Brain mask | SynthStrip | Brain extraction with the author model. | Isolated runtime and weights | [32] |
| Brain mask | MRtrix3 dwi2mask | Native diffusion-volume masking. | MRtrix3 | [29] |
| Preprocessing | MP-PCA | Random-matrix denoising and noise estimation. | DIPY or MRtrix3 dwidenoise | [39] [52] [53] [29] [30] |
| Preprocessing | Local PCA | Overcomplete local-PCA denoising. | DIPY; optional denoising choice | [40] [30] |
| Preprocessing | Patch2Self | Self-supervised diffusion-volume denoising. | DIPY; optional denoising choice | [41] [30] |
| Preprocessing | Gibbs removal | Local subvoxel-shift ringing correction. | DIPY or MRtrix3 mrdegibbs | [42] [29] [30] |
| Preprocessing | Volume registration | Between-volume motion correction and gradient rotation. | DIPY; does not perform FSL eddy correction | [30] |
| Preprocessing | FSL eddy | Eddy-current and motion correction. | MRtrix3 dwifslpreproc; FSL | [43] [29] |
| Preprocessing | FSL topup | Susceptibility-distortion estimation and correction. | FSL; reverse-phase data and acquisition metadata | [44] [29] |
| Microstructure | DTI (default) | LS/WLS tensor fitting; FA, MD, AD, RD, eigenvalues and trace. | SlicerDMRI | [45] [27] [28] |
| Microstructure | Free water | Free-water fraction and tissue-corrected FA/MD; WLS or NLS fitting. | DIPY; suitable multi-shell sampling | [4] [5] [6] [30] |
| Microstructure | NODDI / AMICO | NDI, ODI, IsoVF and fit residuals. | AMICO; suitable multi-shell sampling | [7] [31] |
| Microstructure | DKI | WLS/OLS fitting; MK, AK, RK, KFA, MKT, RTK and validity masks. | DIPY; shell, direction and design-rank checks | [8] [30] |
| Microstructure | MK-Curve | Correction curves, corrected kurtosis maps and metric-specific validity. | Bundled Python backend; DKI eligibility checks | [9] |
| Anatomical prior | DDSeg | Tissue labels and probabilities from converted PyTorch models. | PyTorch; DDSeg weights | [2] |
| Anatomical prior | DDParcel | Anatomical region inference with author-derived models. | PyTorch; weights and registration template | [3] |
| Anatomical prior | DDSurfer | Native white and pial mesh reconstruction. | PyTorch; DDSurfer weights | [1] |
| Anatomical prior | BRAINSFit registration | Template registration for eligible anatomical routes. | Slicer BRAINSFit / BRAINSResample | [51] [27] |
| Anatomical prior | Surface post-processing | Thickness, curvature, spherical registration and DK/Destrieux atlas mapping. | Licensed native component runtime; full suite optional | [33] [47] [48] [49] |
| Tractography | Response estimation | Dhollander three-tissue response estimation. | MRtrix3 | [12] [13] [29] |
| Tractography | CSD / MSMT-CSD | Single- or multi-tissue fibre-orientation distributions. | MRtrix3; selected acquisition route | [11] [46] [10] [29] |
| Tractography | Multi-tissue normalization | Log-domain intensity and inhomogeneity normalization. | MRtrix3 mtnormalise | [17] [18] [29] |
| Tractography | iFOD2 / ACT (default) | Probabilistic tracking with DDSeg-derived tissue constraints. | MRtrix3; reviewed anatomical priors | [14] [15] [29] |
| Tractography | DTI deterministic | Tensor-based direction tracking with stopping criteria. | SlicerDMRI; DIPY | [45] [28] [30] |
| Tractography | UKF two-tensor | Automatic invocation of the official tracking CLI. | UKFTractography extension; SlicerDMRI | [19] [28] |
| Tractography | SAF | Surface-constrained short-association tracking and geometric filtering. | MRtrix3; post-processed native surfaces | [20] |
| Fiber bundles | WMQL (default) | Official bundle queries; optional subsets and regional cerebellar selections. | Author tract_querier; DDParcel labels | [21] |
| Fiber bundles | WMA | ORG, East-West or NABA atlas registration and clustering; automatic UKF handoff. | WMA; selected atlas; UKF reference route | [22] [23] [24] [26] [54] [55] |
| Fiber bundles | TractCloud | Author learned tract parcellation and bundle export. | PyTorch backend; model and centroids | [25] [22] |
| Connectome | Streamline count | Endpoint assignment to DDParcel nodes. | Python or eligible MRtrix3 backend | [50] [29] |
| Connectome | SIFT2-weighted count | FOD-informed weighting and matrix construction with matched tracks. | MRtrix3; corresponding tractogram and weights | [16] [29] [50] |
| Connectome | Scalar / length summaries | Mean FA, MD, ODI or another scalar; mean and total streamline length. | Python API; matched maps, nodes and tracks | [50] [29] [30] |
| Regional analysis | Selected-region analysis | Reuse maps for ROI statistics, filter tracks and extract node submatrices. | Advanced settings; workflow utility using completed outputs | [3] [30] [50] |
Defaults: DTI, CSD/ACT and WMQL. Detailed parameters are in Advanced settings; selected dependencies are prepared separately under Environment and installation. External tools and model assets are not installed silently.
Implementation provenance and validation records document the backend versions and individual test scopes.