cat.report.generate_tables

cat.report.generate_tables#

cat.report.generate_tables(diff: DatasetDiff, sigma_th: float) → dict[str, str]#

Takes the raw results from the CAT routine function and turns them into nice table per cluster.

Parameters:

  • diff (DatasetDiff) – Contains mean and std distance matrix (N x N)

  • sigma_th (float) – Cutoff filter

Returns:

A dictionary containing tables for each cluster. The dataframe can be access in the following way:

tables[dataset_name_from][dataset_name_to][CLUSTER_FIELD]

In the example above, we get the distances from “example_cluster” in the dataset with name: “dataset_name_from”, compared to all clusters in the dataset with the name: dataset_name_to.

Return type:

dict[str, str]

Contents