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.fmriprep_metrics

brainprep.interfaces.fmriprep_metrics(output_dir, fd_mean_threshold=0.2, dvars_std_threshold=1.5, dryrun=False)[source]

FMRIprep quality control.

The following quality metrics are considered:

  • fd_mean : mean framewise displacement, a measure of head motion across the time series.

  • dvars_std : mean standardized DVARS, quantifying the rate of change in BOLD signal intensity between consecutive volumes.

Parameters:
output_dirDirectory

Working directory containing the outputs.

fd_mean_thresholdfloat

Quality control threshold on the Mean Framewise Displacement (mm). Default 0.2.

dvars_std_thresholdfloat

Quality control threshold on the Standardized DVARS. Default 1.5.

dryrunbool

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

Returns:
group_stats_fileFile

A TSV file containing quality metrics. The table includes the columns participant_id, session, run, and fd_mean, dvars_std, as well as a binary qc column indicating the quality control result.

  • participant_id : subject identifier

  • fd_mean : mean framewise displacement

  • dvars_std : mean standardized DVARS

  • qc : quality check output

Notes

Missing metrics (e.g., snr or aor) are filled with NaN.