xcp_d.utils.qcmetrics.make_dcan_df

xcp_d.utils.qcmetrics.make_dcan_df(filtered_motion, name, TR)[source]

Create an HDF5-format file containing a DCAN-format dataset.

Parameters:

  • filtered_motion (str) – Framewise displacement timeseries, potentially after bandstop or low-pass filtering. This is a TSV file with one column: ‘framewise_displacement’.

  • name (str) – Name of the HDF5-format file to be created.

  • TR (float) – Repetition time of the BOLD run, in seconds.

Notes

The metrics in the file are:

  • FD_threshold: a number >= 0 that represents the FD threshold used to calculate the metrics in this list.

  • frame_removal: a binary vector/array the same length as the number of frames in the concatenated time series, indicates whether a frame is removed (1) or not (0)

  • format_string (legacy): a string that denotes how the frames were excluded. This uses a notation devised by Avi Snyder.

  • total_frame_count: a whole number that represents the total number of frames in the concatenated series

  • remaining_frame_count: a whole number that represents the number of remaining frames in the concatenated series

  • remaining_seconds: a whole number that represents the amount of time remaining after thresholding

  • remaining_frame_mean_FD: a number >= 0 that represents the mean FD of the remaining frames