xcp_d.utils.bids.collect_run_data
- xcp_d.utils.bids.collect_run_data(layout, input_type, bold_file, cifti, primary_anat)[source]
Collect data associated with a given BOLD file.
- Parameters:
layout (
bids.layout.BIDSLayout) – BIDSLayout indexing the ingested (e.g., fMRIPrep-format) derivatives.input_type ({“fmriprep”, “dcan”, “hcp”, “nibabies”}) – The format of the incoming preprocessed BIDS derivatives. DCAN- and HCP-format derivatives will automatically be converted to a more BIDS-compliant format. fMRIPrep and Nibabies derivatives are assumed to be roughly equivalent in terms of file organization and naming.
bold_file (
str) – Path to the BOLD file.cifti (
bool) – Post-process surface data (CIFTIs) instead of volumetric data (NIFTIs). This parameter is overridden when DCAN- or HCP-format data are provided. Default is False. Whether to collect files associated with a CIFTI image (True) or a NIFTI (False).primary_anat ({“T1w”, “T2w”}) – The anatomical modality to use for the anat-to-native transform.
- Returns:
run_data – A dictionary of file types (e.g., “confounds”) and associated filenames.
- Return type: