sierra.core.graphs.heatmap#

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

Functions#

`generate_confusion`(→ bool)	Generate a confusion matrix from a `.mean` file.
`generate_dual_numeric`(→ bool)	Generate a side-by-side plot of two heataps from two CSV files.
`generate_numeric`(, xlabel, ylabel, zlabel, large_text, ...)	Generate a X vs. Y vs. Z heatmap plot of a `.mean` file.

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, truth_col: str, predicted_col: str, xlabels_rotate: bool = False, large_text: bool = False) → bool[source]#

Generate a confusion matrix from a .mean file.

If the necessary .mean 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_dual_numeric(pathset: sierra.core.graphs.pathset.PathSet, ipaths: sierra.core.types.PathList, output_stem: pathlib.Path, medium: str, title: 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) → bool[source]#

Generate a side-by-side plot of two heataps from two CSV files.

.mean files must be named as <input_stem_fpath>_X.mean, where X is non-negative integer. Input .mean files must be 2D grids of the same cardinality.

This graph does not plot standard deviation.

If there are not exactly two file paths passed, the graph is not generated.

sierra.core.graphs.heatmap.generate_numeric(pathset: sierra.core.graphs.pathset.PathSet, input_stem: str, output_stem: str, medium: str, title: str, backend: str, colnames: tuple[str, str, str] = ('x', 'y', 'z'), xlabel: str | None = '', ylabel: str | None = '', zlabel: str | 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, ext=config.STATS['mean'].exts['mean']) → bool[source]#

Generate a X vs. Y vs. Z heatmap plot of a .mean file.

If the necessary .mean 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.