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.interfaces.parse_defacing

brainprep.interfaces.parse_defacing(data_dir, output_dir, dryrun=False)

Parse defacing workflow QC data and generate a JSON report.

This function processes defacing quality control data, including overlap and correlation metrics, and generates a JSON report with scatter plots and histograms.

Parameters:

data_dirDirectory

BIDS root directory containing the input data.

output_dirDirectory

Directory where the output JSON report will be saved.

dryrunbool

If True, skip actual computation and file writing. Default False.

Returns:

config_fileFile | None

Path to the generated JSON file if the workflow has been run, otherwise None.