err_heatmap#

beatmap.vis.err_heatmap(bet_results, mask_results, save_file=True, gradient='Greys')#

Creates a heatmap of error values.

Shading corresponds to average error between experimental data and the the theoretical BET isotherm, normalized so that, with default shading, 0 is displayed as white and the maximum error value is black.

Parameters:
bet_resultsnamedtuple

The bet_results.err element is used to create a heatmap of error values.

mask_resultsnamedtuple

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

save_fileboolean

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

gradientstring

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

Returns:
None