xcp_d.utils.confounds.describe_regression

xcp_d.utils.confounds.describe_regression(params, custom_confounds_file, motion_filter_type)[source]

Build a text description of the regression that will be performed.

Parameters:

  • params ({“36P”, “24P”, “27P”, “acompcor”, “acompcor_gsr”, “aroma”, “aroma_gsr”, “custom”}, optional) – Shorthand for the parameter set to extract from the confounds TSV. Default is “36P”, most expansive option.

  • custom_confounds_file (str or None) – Path to custom nuisance regressors.

  • motion_filter_type ({None, “lp”, “notch”}) – Type of filter to use for removing respiratory artifact from motion regressors.

    If None, no filter will be applied.

    If the filter type is set to “notch”, frequencies between band_stop_min and band_stop_max will be removed with a notch filter. In this case, both band_stop_min and band_stop_max must be defined.

    If “lp”, frequencies above band_stop_min will be removed with a Butterworth filter. In this case, only band_stop_min must be defined.

Returns:

desc – A text description of the regression.

Return type:

str