mpl#

Matplotlib figure-generating functions

Functions

`plot_interactions`(optimizer, cor[, clamp])	Plots the parameter interaction matrix
`plot_ofat_ranges`(optimizer, ofat_ranges)	Plots each parameter's 1D OFAT acceptable range

obsidian.plotting.mpl.plot_interactions(optimizer: Optimizer, cor: ndarray, clamp: bool = False)[source]#

Plots the parameter interaction matrix

Parameters:

optimizer (ptimizer) – The optimizer object which contains a surrogate that has been fit to data and can be used to make predictions.
cor (np.ndarray) – The correlation matrix representing the parameter interactions.
clamp (bool, optional) – Whether to clamp the colorbar range to (0, 1). Defaults to False.

Returns:

The parameter interaction plot

Return type:

Figure

obsidian.plotting.mpl.plot_ofat_ranges(optimizer: Optimizer, ofat_ranges: DataFrame) → Figure[source]#

Plots each parameter’s 1D OFAT acceptable range

Parameters:

optimizer (Optimizer) – The optimizer object which contains a surrogate that has been fit to data and can be used to make predictions.
ofat_ranges (pd.DataFrame) – A DataFrame containing the acceptable range values for each parameter, at the low bound, average, and high bound.

Returns:

The parameter OFAT acceptable-range plot

Return type:

Figure