get_extended_plindex#

plinder.core.get_extended_plindex(*, cfg: DictConfig | None = None, plindex: DataFrame | None = None) DataFrame[source]#

The extended PLINDER index includes all of the cluster labels and additional columns that are used in the scoring and splitting.

Parameters:
cfgDictConfig, default=None

the plinder-core config

plindexpd.DataFrame, default=None

the full PLINDER index

Returns:
pd.DataFrame

the extended PLINDER index