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.brainprep_vbm¶
- brainprep.workflow.brainprep_vbm(t1_file, output_dir, keep_intermediate=False, **kwargs)[source]¶
Voxel-based morphometry (VBM) pre-processing.
Applies the VBM pre-processing described in [1].
- Parameters:
- t1_fileFile
Path to the t1 image.
- 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: dict
Dictionary of parsed BIDS entities.
- Returns:
- Bunch
A dictionary-like object containing:
gm_file : File - path to the NIIGZ modulated, normalized gray matter segmentation of the input T1-weighted MRI image.
qc_file : File - path to the PDF visual report.
batch_file : File - path to the CAT12 batch file.
- Raises:
- ValueError
If the T1w file do not follow BIDS contension.
References