sobol_graph module¶

A network of uncertain variables representing their Sobol’ indices.

class gemseo_umdo.visualizations.sobol_graph.SobolGraph(first_order_indices, total_order_indices, second_order_indices, threshold=0.1, maximum_thickness=10.0)[source]

Bases: GraphView

A network of uncertain variables representing their Sobol’ indices.

A node represents an uncertain variable whose name is written inside, followed by its first-order and total-order Sobol’ indices.

The thickness of a node is proportional to the total-order Sobol’ index of the variable while the thickness of an edge is proportional to the second-order Sobol’ index of the corresponding pair of variables.

Args:

Note

All parameters are optional and can be changed under their corresponding attribute name after instance creation.

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

Parameters:

first_order_indices (Mapping[str, float]) – The first-order Sobol’ indices of the scalar inputs, shaped as {name: index}.
total_order_indices (Mapping[str, float]) – The total-order Sobol’ indices of the scalar inputs, shaped as {name: index}.
second_order_indices (Mapping[tuple[str, str], float]) – The second-order Sobol’ indices of the scalar inputs, shaped as {(name, other_name): index}.
threshold (float) –
The sensitivity threshold above which a second-order index is significant and the corresponding edge plotted.

By default it is set to 0.1.
maximum_thickness (float) –
The maximum thickness of a line.

By default it is set to 10.0.

classmethod from_analysis(analysis, output_name, output_component=0)[source]

Create the Sobol’ graph from a Sobol’ analysis.

Parameters:

analysis (SobolAnalysis) – A Sobol’ analysis.
output_name (str) – The name of the output.
output_component (int) –
The component of the output.

By default it is set to 0.

Returns:

The Sobol’ graph associated with this Sobol’ analysis.

Return type:

SobolGraph

DEFAULT_FILE_PATH: ClassVar[str | Path] = 'sobol_graph.png': The default file path to save the graph.

threshold: float: The threshold above which an edge is significant.