Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

brainprep.workflow.vbm.brainprep_longitudinal_vbm

brainprep.workflow.vbm.brainprep_longitudinal_vbm(t1_files, model, output_dir, keep_intermediate=False, **kwargs)[source]

Longitudinal voxel based morphometry (VBM) pre-processing.

Applies the VBM pre-processing described in [1].

Parameters:
t1_fileslist[File]

Path to the t1 image.

modelint

Longitudinal model choice: 1 short time (weeks), 2 long time (years) between images sessions.

output_dirDirectory

Path to the output directory.

keep_intermediatebool

If True, retains intermediate results (i.e., the workspace); useful for debugging. Default False.

**kwargsdict
entities: list[dict]

Dictionaries of parsed BIDS entities.

Returns:
Bunch

A dictionary-like object containing:

  • gm_files : list[File] - path to the NIIGZ modulated, normalized gray matter segmentations of the input T1-weighted MRI images.

  • qc_files : list[File] - path to the PDF visual reports.

  • batch_file : File - path to the CAT12 batch file.

Raises:
ValueError

If the T1w file do not follow BIDS convention.

References