sierra.core.graphs.heatmap

Heatmap graph generation classes for stage{4,5}.

Functions

generate_confusion(→ bool)	Generate a confusion matrix.
generate_numeric(→ bool)	Generate a X vs. Y vs. Z heatmap plot.

Module Contents

sierra.core.graphs.heatmap.generate_confusion(pathset: sierra.core.graphs.pathset.PathSet, input_stem: str, output_stem: str, medium: str, title: str, backend: str, truthcol: str, predcol: str, stats_center: str, *, xlabels_rotate: bool = False, large_text: bool = False) → bool

Generate a confusion matrix.

If the necessary input file does not exist, the graph is not generated. Dataframe must be constructed with {truth,predicted} columns; e.g.:

truth,predicted
a,a
a,q
b,b
c,c
d,f
e,e
...

sierra.core.graphs.heatmap.generate_numeric(pathset: sierra.core.graphs.pathset.PathSet, input_stem: str, output_stem: str, medium: str, title: str, backend: str, stats_center: str, xcol: str, ycol: str, zcol: str, *, xlabel: str | None = None, ylabel: str | None = None, zlabel: str | None = None, large_text: bool = False, xticklabels: list[str] | None = None, yticklabels: list[str] | None = None, xticks: list[float] | None = None, yticks: list[float] | None = None, transpose: bool = False) → bool

Generate a X vs. Y vs. Z heatmap plot.

If the necessary input file does not exist, the graph is not generated. Dataframe must be constructed with {x,y,z} columns; e.g.:

x,y,z
0,0,4
0,1,5
0,2,6
0,3,4
1,0,4
0,1,4
...

The x, y columns are the indices, and the z column is the value in that cell. The names of these columns are configurable.