hots.visualization.plot API

Plotting utilities for HOTS.

Design: - All plotting functions live here. - A single VisualizationConfig controls saving, colors, layout parameters, etc. - Each plot returns (fig, saved_path) where saved_path is a Path or None.

Saving rules:

• If out_path is provided -> save there (even if viz.save.plots_folder is None)

• Else save to viz.save.plots_folder if:

  • viz.enabled is True

  • viz.save.enabled is True

  • viz.save.plots_folder is not None

• If saving occurs, figure is closed if viz.save.close_on_save is True (default).

hots.visualization.plot.init_containers_plot(df_indiv: DataFrame, *, viz: VisualizationConfig, sep_time: float | None, fields: FieldNames, metric: str | None = None, title: str | None = None) → tuple[Figure, Axes]

hots.visualization.plot.init_nodes_plot(df_indiv: DataFrame, *, viz: VisualizationConfig, dict_id_n: Mapping[int, str] | None, sep_time: float | None, max_cap: float, fields: FieldNames, metric: str | None = None, title: str | None = None) → tuple[Figure, Axes]

hots.visualization.plot.plot_cluster_profiles(profiles: ndarray, *, viz: VisualizationConfig, title: str | None = None, out_path: str | Path | None = None, filename: str | None = None) → tuple[Figure, Path | None]

hots.visualization.plot.plot_clustering(df_clust: DataFrame, *, viz: VisualizationConfig, dict_id_c: Mapping[int, int] | None = None, metric: str | None = None, title: str | None = None, out_path: str | Path | None = None, filename: str | None = None) → tuple[Figure, Path | None]

hots.visualization.plot.plot_clustering_containers_by_node(df_indiv: DataFrame, *, viz: VisualizationConfig, labels: Sequence[int], dict_id_c: Mapping[int, int] | None, fields: FieldNames, metric: str | None = None, filter_biggest_cluster: bool = False, title: str | None = None, out_path: str | Path | None = None, filename: str | None = None) → tuple[Figure, Path | None]

hots.visualization.plot.plot_clustering_spec_cont(df_clust: DataFrame, *, viz: VisualizationConfig, containers_to_show: Sequence[str | int], dict_id_c: Mapping[int, int] | None = None, metric: str | None = None, title: str | None = None, out_path: str | Path | None = None, filename: str | None = None) → tuple[Figure, Path | None]

hots.visualization.plot.plot_conflict_graph(graph: Graph, *, viz: VisualizationConfig, title: str | None = None, out_path: str | Path | None = None, filename: str | None = None) → tuple[Figure, Path | None]

hots.visualization.plot.plot_containers_clustering_together(df_clust: DataFrame, *, viz: VisualizationConfig, metric: str | None = None, title: str | None = None, out_path: str | Path | None = None, filename: str | None = None) → tuple[Figure, Path | None]

hots.visualization.plot.plot_containers_groupby_nodes(df_indiv: DataFrame, *, viz: VisualizationConfig, max_cap: float, sep_time: float | None, fields: FieldNames, metric: str | None = None, title: str | None = None, out_path: str | Path | None = None, filename: str | None = None) → tuple[Figure | None, Path | None]

hots.visualization.plot.plot_dendrogram(z_all: ndarray, *, viz: VisualizationConfig, title: str | None = None, out_path: str | Path | None = None, filename: str | None = None) → tuple[Figure, Path | None]

hots.visualization.plot.update_containers_plot(ax: Axes, df_indiv: DataFrame, *, viz: VisualizationConfig, fields: FieldNames, metric: str | None = None) → None

hots.visualization.plot.update_nodes_plot(ax: Axes, df_indiv: DataFrame, *, viz: VisualizationConfig, dict_id_n: Mapping[int, str] | None, fields: FieldNames, metric: str | None = None) → None