Options for Post-processing algorithms¶

BasicHistory¶

Module: gemseo.post.basic_history

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
data_list (Sequence[str])

The names of the variables.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.

ConstraintsHistory¶

Module: gemseo.post.constraints_history

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
constraints_list (Sequence[str])

The names of the constraints.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.

Correlations¶

Module: gemseo.post.correlations

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
coeff_limit (float)

The plot is not made if the correlation between the variables is lower than this limit.

By default it is set to 0.95.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
func_names (Optional[Sequence[str]])

The function names subset for which the correlations are computed. If None, all functions are considered.

By default it is set to None.
n_plots_x (int)

The number of horizontal plots.

By default it is set to 5.
n_plots_y (int)

The number of vertical plots.

By default it is set to 5.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.

GradientSensitivity¶

Module: gemseo.post.gradient_sensitivity

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
iteration (int)

The iteration to plot the sensitivities; if negative, use the optimum.

By default it is set to -1.
save (bool)

If True, save the figure.

By default it is set to True.
scale_gradients (bool)

If True, normalize each gradient w.r.t. the design variables.

By default it is set to False.
show (bool)

If True, display the figure.

By default it is set to False.

KMeans¶

Module: gemseo.post.kmeans

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
directory_path (Optional[Union[str,Path]])

By default it is set to None.
fig_size (Optional[Tuple[float,)

By default it is set to None.
file_extension (Optional[str])

By default it is set to None.
file_name (Optional[str])

By default it is set to None.
file_path (Optional[Path])

By default it is set to None.
n_clusters (int)

The number of clusters.

By default it is set to 5.
save (bool)

By default it is set to True.
self (OptPostProcessorOptionType)
show (bool)

By default it is set to False.

ObjConstrHist¶

Module: gemseo.post.obj_constr_hist

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
constr_names (Optional[Sequence[str]])

The names of the constraints to plot. If None, use all the constraints.

By default it is set to None.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.

OptHistoryView¶

Module: gemseo.post.opt_history_view

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
obj_max (Optional[float])

The maximum value for the objective in the plot. If None, use the maximum value of the objective history.

By default it is set to None.
obj_min (Optional[float])

The minimum value for the objective in the plot. If None, use the minimum value of the objective history.

By default it is set to None.
obj_relative (bool)

If True, plot the objective value difference with the initial value.

By default it is set to False.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.
variables_names (Optional[Sequence[str]])

The names of the variables to display. If None, use all design variables.

By default it is set to None.

ParallelCoordinates¶

Module: gemseo.post.para_coord

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
save (bool)

If True, save the figure.

By default it is set to True.
self (OptPostProcessorOptionType)
show (bool)

If True, display the figure.

By default it is set to False.

ParetoFront¶

Module: gemseo.post.pareto_front

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
objectives (Optional[Sequence[str]])

The functions names or design variables to plot. If None, use the objective function (may be a vector).

By default it is set to None.
objectives_labels (Optional[Sequence[str]])

The labels of the objective components. If None, use the objective name suffixed by an index.

By default it is set to None.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.
show_non_feasible (bool)

If True, show the non feasible points in the plot.

By default it is set to True.

QuadApprox¶

Module: gemseo.post.quad_approx

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
func_index (Optional[int])

The index of the output of interest to be defined if the function has a multidimensional output. If None and if the output is multidimensional, an error is raised.

By default it is set to None.
function (str)

The function name to build the quadratic approximation.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.

RadarChart¶

Module: gemseo.post.radar_chart

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
constraints_list (Sequence[str])

The names of the constraints.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
iteration (int)

The number of iteration to post-process.

By default it is set to -1.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.

Robustness¶

Module: gemseo.post.robustness

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.
stddev (float)

The standard deviation of the inputs as fraction of x bounds.

By default it is set to 0.01.

SOM¶

Module: gemseo.post.som

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
annotate (bool)

If True, add label of neuron value to SOM plot.

By default it is set to False.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
n_x (int)

The number of grids in x.

By default it is set to 4.
n_y (int)

The number of grids in y.

By default it is set to 4.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.

ScatterPlotMatrix¶

Module: gemseo.post.scatter_mat

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
filter_non_feasible (bool)

If True, remove the non-feasible points from the data.

By default it is set to False.
save (bool)

If True, save the figure.

By default it is set to True.
show (bool)

If True, display the figure.

By default it is set to False.
variables_list (Sequence[str])

The functions names or design variables to plot. If the list is empty, plot all design variables.

VariableInfluence¶

Module: gemseo.post.variable_influence

Here are the options available in GEMSEO:

Options

**options (OptPostProcessorOptionType)

The options of the post-processor.
absolute_value (bool)

If True, plot the absolute value of the influence.

By default it is set to False.
directory_path (Optional[Path])

The path of the directory to save the figures. If None, use the current working directory.

By default it is set to None.
fig_size (Optional[Tuple[float,)

The width and height of the figure in inches, e.g. (w, h). If None, use the DEFAULT_FIG_SIZE of the post-processor.

By default it is set to None.
file_extension (Optional[str])

A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

By default it is set to None.
file_name (Optional[str])

The name of the file to save the figures. If None, use a default one generated by the post-processing.

By default it is set to None.
file_path (Optional[Path])

The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

By default it is set to None.
log_scale (bool)

If True, use a logarithmic scale.

By default it is set to False.
quantile (float)

Between 0 and 1, the proportion of the total sensitivity to use as a threshold to filter the variables.

By default it is set to 0.99.
save (bool)

If True, save the figure.

By default it is set to True.
save_var_files (bool)

If True, save the influent variables indices as a NumPy file.

By default it is set to False.
show (bool)

If True, display the figure.

By default it is set to False.