gemseo.post.correlations module

Correlations in the optimization database.

class Correlations(opt_problem)

Bases: BasePost[Correlations_Settings]

Scatter plots of the correlated variables.

These variables can be design variables, constraints, objective or observables. This post-processor considers all the correlations greater than a threshold.

Initialize self. See help(type(self)) for accurate signature.

Parameters:

opt_problem (OptimizationProblem) -- The optimization problem to be post-processed.

Settings

alias of Correlations_Settings

static func_order(func_names, x)

Key function to sort function components.

Parameters:

• func_names (Sequence[str]) -- The functions names in the required order.

• x (str) -- An element from a list.

Returns:

The index to be given to the sort method and the function name associated to that index.

Return type:

tuple[int, str]

MAXIMUM_CORRELATION_COEFFICIENT: ClassVar[float] = 0.999999999

The maximum correlation coefficient above which the variable is not plotted.