xcp_d.utils.bids.collect_data

xcp_d.utils.bids.collect_data(bids_dir, input_type, participant_label, task=None, bids_validate=False, bids_filters=None, cifti=False, layout=None)[source]

Collect data from a BIDS dataset.

Parameters:

  • bids_dir

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

  • participant_label

  • task

  • bids_validate

  • bids_filters

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

  • layout (bids.layout.BIDSLayout) – BIDSLayout indexing the ingested (e.g., fMRIPrep-format) derivatives.

Returns:

  • layout (bids.layout.BIDSLayout) – BIDSLayout indexing the ingested (e.g., fMRIPrep-format) derivatives.

  • subj_data (dict)