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.qualcheck.mriqc_metrics¶
- brainprep.interfaces.qualcheck.mriqc_metrics(iqm_files, output_dir, dryrun=False)[source]¶
Filter MRIQC group-level metrics according to modality-specific defaults.
Each input file must follow the naming pattern
group_<modality>.tsv. Based on the modality extracted from the filename (e.g., T1w, bold, dwi), a predefined set of uncorrelated Image Quality Metrics (IQMs) is selected. The function then writes a filtered TSV file containing only those metrics to the specified output directory.- Parameters:
- iqm_fileslist[File]
Paths to MRIQC group-level metrics files.
- output_dirDirectory
Directory where the filtered metrics will be written.
- dryrunbool
If True, skip actual computation and file writing. Default False.
- Returns:
- filter_iqm_fileslist[File]
Paths to the selected set of uncorrelated group-level IQMs.
- Raises:
- ValueError
If modality extracted from the filename is unsupported If the filename does not follow the expected pattern
group_<modality>.tsv.