Options for Post-processing algorithms¶
BasicHistory¶
Module: gemseo.post.basic_history
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
variable_names : Sequence[str]
The names of the variables.
ConstraintsHistory¶
Module: gemseo.post.constraints_history
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
constraint_names : Sequence[str]
The names of the constraints.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
Correlations¶
Module: gemseo.post.correlations
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
coeff_limit : float, optional
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 : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
func_names : Sequence[str] | None, optional
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, optional
The number of horizontal plots.
By default it is set to 5.
n_plots_y : int, optional
The number of vertical plots.
By default it is set to 5.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
GradientSensitivity¶
Module: gemseo.post.gradient_sensitivity
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
iteration : int, optional
The iteration to plot the sensitivities; if negative, use the optimum.
By default it is set to -1.
save : bool, optional
If True, save the figure.
By default it is set to True.
scale_gradients : bool, optional
If True, normalize each gradient w.r.t. the design variables.
By default it is set to False.
show : bool, optional
If True, display the figure.
By default it is set to False.
KMeans¶
Module: gemseo.post.kmeans
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The post-processor options.
directory_path : str | Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
n_clusters : int, optional
The number of clusters.
By default it is set to 5.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
ObjConstrHist¶
Module: gemseo.post.obj_constr_hist
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
constr_names : Sequence[str] | None, optional
The names of the constraints to plot. If None, use all the constraints.
By default it is set to None.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
OptHistoryView¶
Module: gemseo.post.opt_history_view
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
obj_max : float | None, optional
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 : float | None, optional
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, optional
If True, plot the objective value difference with the initial value.
By default it is set to False.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
variables_names : Sequence[str] | None, optional
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
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The post-processor options.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
ParetoFront¶
Module: gemseo.post.pareto_front
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
objectives : Sequence[str] | None, optional
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 : Sequence[str] | None, optional
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, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
show_non_feasible : bool, optional
If True, show the non feasible points in the plot.
By default it is set to True.
QuadApprox¶
Module: gemseo.post.quad_approx
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
func_index : int | None, optional
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, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
RadarChart¶
Module: gemseo.post.radar_chart
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
constraint_names : Iterable[str] | None, optional
The names of the constraints. If None, use all the constraints.
By default it is set to None.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
iteration : int | RadarChart.OPTIMUM, optional
Either a database index in \(-N+1,\ldots,-1,0,1,\) or the tag
OPTIMUM
for the database index at which the optimum is located, where \(N\) is the length of the database.By default it is set to opt.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
show_names_radially : bool, optional
Whether to write the names of the constraints in the radial direction. Otherwise, write them horizontally. The radial direction can be useful for a high number of constraints.
By default it is set to False.
Robustness¶
Module: gemseo.post.robustness
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
stddev : float, optional
The standard deviation of the inputs as fraction of x bounds.
By default it is set to 0.01.
SOM¶
Module: gemseo.post.som
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
annotate : bool, optional
If True, add label of neuron value to SOM plot.
By default it is set to False.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
n_x : int, optional
The number of grids in x.
By default it is set to 4.
n_y : int, optional
The number of grids in y.
By default it is set to 4.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
ScatterPlotMatrix¶
Module: gemseo.post.scatter_mat
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
filter_non_feasible : bool, optional
If True, remove the non-feasible points from the data.
By default it is set to False.
save : bool, optional
If True, save the figure.
By default it is set to True.
show : bool, optional
If True, display the figure.
By default it is set to False.
variable_names : 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
Mandatory and optional parameters:
- Parameters
**options : OptPostProcessorOptionType
The options of the post-processor.
absolute_value : bool, optional
If True, plot the absolute value of the influence.
By default it is set to False.
directory_path : Path | None, optional
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 : tuple[float, float] | None, optional
The width and height of the figure in inches, e.g. (w, h). If None, use the
OptPostProcessor.DEFAULT_FIG_SIZE
of the post-processor.By default it is set to None.
file_extension : str | None, optional
A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.
By default it is set to None.
file_name : str | None, optional
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 : Path | None, optional
The path of the file to save the figures. If the extension is missing, use
file_extension
. If None, create a file path fromdirectory_path
,file_name
andfile_extension
.By default it is set to None.
log_scale : bool, optional
If True, use a logarithmic scale.
By default it is set to False.
quantile : float, optional
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, optional
If True, save the figure.
By default it is set to True.
save_var_files : bool, optional
If True, save the influent variables indices as a NumPy file.
By default it is set to False.
show : bool, optional
If True, display the figure.
By default it is set to False.