vis

beatmap.vis.experimental_data_plot(bet_results)

Creates a scatter plot of experimental data.

beatmap.vis.ssa_heatmap(bet_results, rouq_mask)

Creates a heatmap of specific surface areas.

beatmap.vis.err_heatmap(bet_results, rouq_mask)

Creates a heatmap of error values.

beatmap.vis.bet_combo_plot(bet_results, …)

Creates two BET plots, for the minimum and maxium error data sets.

beatmap.vis.bet_iso_combo_plot(bet_results, …)

Creates an image displaying the relative pressure range with minimum error and the BET isotherm on the same plot.

beatmap.vis.ascii_tables(bet_results, rouq_mask)

Creates and prints ASCII formatted tables of BET results.

beatmap.vis.dataframe_tables(bet_results, …)

Creates and populates pandas dataframes summarizing BET results.

beatmap.vis.experimental_data_plot(bet_results, save_file=False)[source]

Creates a scatter plot of experimental data.

Typical isotherm presentation where x-axis is relative pressure, y-axis is specific amount adsorbed.

Parameters
  • bet_results (namedtuple) – The bet_results.raw_data field is used to create a plot of isotherm data.

  • save_file (boolean) – When save_file=True a .png of the figure is created in the working directory.

beatmap.vis.ssa_heatmap(bet_results, rouq_mask, save_file=True, gradient='Greens')[source]

Creates a heatmap of specific surface areas.

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

Parameters
  • bet_results (namedtuple) – The bet_results.ssa field is used to create a heatmap of specific surface area answers.

  • rouq_mask (namedtuple) – The rouq_mask.mask field is used to mask the specific surface area heatmap so that only valid results are displayed.

  • save_file (boolean) – When save_file = True a png of the figure is created in the working directory.

  • gradient (string) – Color gradient for heatmap, must be a vaild color gradient name in the seaborn package

beatmap.vis.err_heatmap(bet_results, rouq_mask, save_file=True, gradient='Greys')[source]

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_results (namedtuple) – The bet_results.err field is used to create a heatmap of error values,

  • rouq_mask (namedtuple) – The rouq_mask.mask field is used to mask the error heatmap so that only valid results are displayed.

  • save_file (boolean) – When save_file = True a png of the figure is created in the working directory.

  • gradient (string) – Color gradient for heatmap, must be a vaild color gradient name in the seaborn package, default is grey.

beatmap.vis.bet_combo_plot(bet_results, rouq_mask, save_file=True)[source]

Creates two BET plots, for the minimum and maxium error data sets.

Only datapoints in the minimum and maximum error data sets are plotted. Equation for best fit line and corresponding R value are annotated on plots Image is 2 by 1, two BET plots arranged horizontally in one image.

Parameters
  • bet_results (namedtuple) – Namedtuple where the bet_results.raw_data element is used to create a plot of isotherm BET values.

  • rouq_mask (namedtuple) – The rouq_mask.mask element is used to mask the BET results so that only valid results are displayed.

  • save_file (boolean) – When save_file = True a png of the figure is created in the working directory.

beatmap.vis.bet_iso_combo_plot(bet_results, rouq_mask, save_file=True)[source]

Creates an image displaying the relative pressure range with minimum error and the BET isotherm on the same plot. The point where n/nm = 1 is is the point where the BET monolayer loading is achieved.

Parameters
  • bet_results (named tuple) – The bet_results.raw_data element is used to create a plot of isotherm data.

  • rouq_mask (named tuple) – The rouq_mask.mask element is used to mask the BET results so that only valid results are displayed.

  • save_file (boolean) – When save_file = True a png of the figure is created in the working directory.

beatmap.vis.ascii_tables(bet_results, rouq_mask)[source]

Creates and prints ASCII formatted tables of BET results.

Parameters
  • bet_results (namedtuple) –

    Contains elements that result from BET analysis. Relevant fields are:

    • bet_results.raw_data (dataframe) : experimental isotherm data.

    • bet_results.ssa (array) : specific surface areas for all relp

    ranges. - bet_results.c (array) : BET constants for all relp ranges. - bet_results.err (array) : error values for all relp ranges.

  • rouq_mask (namedtuple) –

    Contains the results of applying the Rouquerol criteria to BET results. Relevant fields are:

    • rouq_mask.mask (MaskedArray) : object where invalid BET results

    are masked.

beatmap.vis.dataframe_tables(bet_results, rouq_mask)[source]

Creates and populates pandas dataframes summarizing BET results.

Parameters
bet_resultsnamedtuple

Contains elements that result from BET analysis. Relevant fields are:

  • bet_results.raw_data (dataframe) : experimental isotherm data.

  • bet_results.ssa (array) : specific surface areas for all relp

ranges. - bet_results.c (array) : BET constants for all relp ranges. - bet_results.err (array) : error values for all relp ranges.

rouq_masknamedtuple

Contains the results of applying the Rouquerol criteria to BET results. Relevant fields are:

  • rouq_mask.mask (MaskedArray) : object where invalid BET results

are masked.

ssa_tabledataframe

Summary of BET results, highlighting the high, low, and average values of specific surface area.

c_tabledataframe

Summary of BET results, highlighting the high, low, and average values of the BET constant.

ssa_stdfloat

Atandard deviation of valid specific surface area values.

c_stdfloat

Standard deviation of valid BET constant values.