ssa_heatmap#

beatmap.vis.ssa_heatmap(bet_results, mask_results, save_file=True, gradient='Greens')#

Creates a heatmap of specific surface areas.

Shading corresponds to specific surface area, normalized for the minimum and maximum specific sa values.

Parameters:
bet_resultsnamedtuple

The bet_results.ssa element is used to create a heatmap of specific surface area answers.

mask_resultsnamedtuple

The mask_results.mask element is used to mask the specific surface area heatmap so that only valid results are displayed.

save_filebool

When save_file = True a png of the figure is created in the working directory.

gradientstr

Color gradient for heatmap, must be a vaild color gradient name in the seaborn package.

Returns:
None