qolmat.benchmark.metrics.sum_energy_distances

qolmat.benchmark.metrics.sum_energy_distances(df1: DataFrame, df2: DataFrame, df_mask: DataFrame) Series[source]

Compute the sum of energy distances between df1 and df2.

It is based on https://dcor.readthedocs.io/en/latest/theory.html#

Parameters
df1pd.DataFrame

true dataframe

df2pd.DataFrame

predicted dataframe

df_maskpd.DataFrame

Elements of the dataframes to compute on

Returns
pd.Series

Sum of energy distances between df1 and df2.