Post-processing algorithms

Warning

Some algorithms may require the installation of GEMSEO with all its features and some others may depend on plugins.

Note

All the features of the wrapped optimization libraries may not be exposed through GEMSEO.

BasicHistory

Module: gemseo.post.basic_history

Required parameters
  • variable_names : Sequence[str]

    The names of the variables.

Optional parameters
  • 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 from directory_path, file_name and file_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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

Compromise

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.compromise

Optional parameters
  • **scalar_options : Any

    The keyword arguments for the scalarization function.

  • 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 from directory_path, file_name and file_extension.

    By default it is set to None.

  • plot_arrow : bool, optional

    Whether to plot arrows connecting the utopia point to the compromise points. The arrows are annotated with the 2-norm ( Euclidian distance ) of the vector represented by the arrow.

    By default it is set to False.

  • plot_extra : bool, optional

    Whether to plot the extra pareto related points, i.e. utopia, nadir and anchor points.

    By default it is set to True.

  • plot_legend : bool, optional

    Whether to show the legend.

    By default it is set to True.

  • save : bool, optional

    If True, save the figure.

    By default it is set to True.

  • scalar_name : str, optional

    The name of the scalarization function to use.

    By default it is set to weighted-sum.

  • show : bool, optional

    If True, display the figure.

    By default it is set to False.

  • weights : ndarray | None, optional

    The weights for the scalarization function. If None, a normalized array is used, e.g. [1./n, 1./n, …, 1./n] for an optimization problem with n-objectives.

    By default it is set to None.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

ConstraintsHistory

Module: gemseo.post.constraints_history

Required parameters
  • constraint_names : Sequence[str]

    The names of the constraints.

Optional parameters
  • 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 from directory_path, file_name and file_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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

Correlations

Module: gemseo.post.correlations

Optional parameters
  • coeff_limit : float, optional

    The minimum correlation coefficient below which the variable is not plotted.

    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 from directory_path, file_name and file_extension.

    By default it is set to None.

  • func_names : Sequence[str] | None, optional

    The names of the functions to be considered. 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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

GradientSensitivity

Module: gemseo.post.gradient_sensitivity

Optional parameters
  • compute_missing_gradients : bool, optional

    Whether to compute the gradients at the selected iteration if they were not computed by the algorithm.

    Activating this option may add considerable computation time depending on the cost of the gradient evaluation. This option will not compute the gradients if the OptimizationProblem instance was imported from an HDF5 file. This option requires an OptimizationProblem with a gradient-based algorithm.

    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 from directory_path, file_name and file_extension.

    By default it is set to None.

  • iteration : int | None, optional

    The iteration to plot the sensitivities. Can use either positive or negative indexing, e.g. 4 for the 5-th iteration or -2 for the penultimate one. If None, use the iteration of the optimum.

    By default it is set to None.

  • 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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

HighTradeOff

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.high_tradeoff

Optional 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 from directory_path, file_name and file_extension.

    By default it is set to None.

  • plot_arrow : bool, optional

    Whether to plot arrows connecting the utopia point to the compromise points. The arrows are annotated with the 2-norm ( Euclidian distance ) of the vector represented by the arrow.

    By default it is set to False.

  • plot_extra : bool, optional

    Whether to plot the extra pareto related points, i.e. utopia, nadir and anchor points.

    By default it is set to True.

  • plot_legend : bool, optional

    Whether to show the legend.

    By default it is set to True.

  • 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.

  • **high_tradeoff_options : Any

    The keyword arguments for the class pymoo.mcdm.high_tradeoff.HighTradeoffPoints.

KMeans

Module: gemseo.post.kmeans

Optional parameters
  • 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 from directory_path, file_name and file_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.

  • **options : OptPostProcessorOptionType

    The post-processor options.

MultiObjectiveDiagram

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.core.multi_objective_diagram

Required parameters
  • diagram : str

    The type of the diagram to be created.

  • scalar_name : str

    The name of the scalarization function to use.

  • weights : ndarray

    The weights for the scalarization function.

Optional parameters
  • **scalar_options : Any

    The keyword arguments for the scalarization function.

  • 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 from directory_path, file_name and file_extension.

    By default it is set to None.

  • normalize_each_objective : bool, optional

    Whether the objectives should be normalized.

    By default it is set to True.

  • 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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

ObjConstrHist

Module: gemseo.post.obj_constr_hist

Optional parameters
  • constraint_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 from directory_path, file_name and file_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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

OptHistoryView

Module: gemseo.post.opt_history_view

Optional parameters
  • 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 from directory_path, file_name and file_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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

ParallelCoordinates

Module: gemseo.post.para_coord

Optional parameters
  • 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 from directory_path, file_name and file_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.

  • **options : OptPostProcessorOptionType

    The post-processor options.

ParetoFront

Module: gemseo.post.pareto_front

Optional parameters
  • 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 from directory_path, file_name and file_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 (maybe 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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

Petal

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.petal

Required parameters
  • scalar_name : str

    The name of the scalarization function to use.

  • weights : ndarray

    The weights for the scalarization function.

Optional parameters
  • **scalar_options : Any

    The keyword arguments for the scalarization function.

  • 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 from directory_path, file_name and file_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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

QuadApprox

Module: gemseo.post.quad_approx

Required parameters
  • function : str

    The function name to build the quadratic approximation.

Optional parameters
  • 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 from directory_path, file_name and file_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.

  • 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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

Radar

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.radar

Required parameters
  • scalar_name : str

    The name of the scalarization function to use.

  • weights : ndarray

    The weights for the scalarization function.

Optional parameters
  • **scalar_options : Any

    The keyword arguments for the scalarization function.

  • 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 from directory_path, file_name and file_extension.

    By default it is set to None.

  • normalize_each_objective : bool, optional

    Whether the objectives should be normalized.

    By default it is set to True.

  • 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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

RadarChart

Module: gemseo.post.radar_chart

Optional parameters
  • 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 from directory_path, file_name and file_extension.

    By default it is set to None.

  • iteration : int | RadarChart.OPTIMUM, optional

    Either a database index in \(-N+1,\ldots,-1,0,1,`ldots,N-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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

Robustness

Module: gemseo.post.robustness

Optional parameters
  • 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 from directory_path, file_name and file_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 normal uncertain variable to be added to the optimal design value; expressed as a fraction of the bounds of the design variables.

    By default it is set to 0.01.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

SOM

Module: gemseo.post.som

Optional parameters
  • 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 from directory_path, file_name and file_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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

ScatterPareto

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.scatter_pareto

Optional parameters
  • **scatter_options : Any

    The keyword arguments for the class pymoo.visualization.scatter.Scatter.

  • 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 from directory_path, file_name and file_extension.

    By default it is set to None.

  • plot_arrow : bool, optional

    Whether to plot arrows connecting the utopia point to the compromise points. The arrows are annotated with the 2-norm ( Euclidian distance ) of the vector represented by the arrow.

    By default it is set to False.

  • plot_extra : bool, optional

    Whether to plot the extra pareto related points, i.e. utopia, nadir and anchor points.

    By default it is set to True.

  • plot_legend : bool, optional

    Whether to show the legend.

    By default it is set to True.

  • point_labels : Sequence[str], optional

    The label of the points of interest. If a list is provided, it must contain as many labels as the points of interest. Moreover, in the last case, each point will have a different color.

    By default it is set to points.

  • points : ndarray | None, optional

    The points of interest to be plotted. If None, only the pareto front is plot along with extra point (depending on plot_extra value).

    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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

ScatterPlotMatrix

Module: gemseo.post.scatter_mat

Required parameters
  • variable_names : Sequence[str]

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

Optional parameters
  • 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 from directory_path, file_name and file_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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.

VariableInfluence

Module: gemseo.post.variable_influence

Optional parameters
  • absolute_value : bool, optional

    Whether to 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 from directory_path, file_name and file_extension.

    By default it is set to None.

  • level : float, optional

    The proportion of the total sensitivity to use as a threshold to filter the variables.

    By default it is set to 0.99.

  • log_scale : bool, optional

    Whether to set the y-axis as log scale.

    By default it is set to False.

  • save : bool, optional

    If True, save the figure.

    By default it is set to True.

  • save_var_files : bool, optional

    Whether to save the influential variables indices to 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.

  • **options : OptPostProcessorOptionType

    The options of the post-processor.