tedana.metrics.external.fit_max_rp_corr_to_regressors

fit_max_rp_corr_to_regressors(component_table: DataFrame, external_regressors: DataFrame, external_regressor_config: Dict, mixing: ndarray[tuple[int, ...], dtype[_ScalarType_co]], detrend_regressors: DataFrame, seed: int = 0) → DataFrame[source]

Calculate max_rp_corr from specified external regressor columns.

Parameters:

  • component_table ((C x X) pandas.DataFrame) – Component metric table. One row for each component, with a column for each metric.

  • external_regressors ((T x R) pandas.DataFrame) – External regressor time series.

  • external_regressor_config (dict) – Single external regressor config entry. Required keys: regress_ID, regressors, detrend, statistic.

  • mixing ((T x C) array_like) – ICA mixing matrix.

  • detrend_regressors ((T x P) pandas.DataFrame) – Legendre polynomial basis for optional detrending.

  • seed (int, optional) – Random seed for the max_rp_corr subsampling. Default is 0.

Returns:

component_table ((C x X) pandas.DataFrame) – Input table with "max_rp_corr {regress_ID} model" column added.