..
   Copyright 2021 IRT Saint-Exupéry, https://www.irt-saintexupery.com

   This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
   International License. To view a copy of this license, visit
   http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative
   Commons, PO Box 1866, Mountain View, CA 94042, USA.

.. _gen_post_algos:

Post-processing algorithms
==========================

.. warning::
   Some capabilities may require the :ref:`installation <installation>` of |g| with :ref:`all its features <dependencies>`
   and some others may depend on :ref:`plugins <plugins>`.

.. warning::
   All the features of the wrapped libraries may not be exposed through |g|.


.. note::
   The algorithm settings can be passed to a function of the form

   .. code-block:: python

      function(..., settings_model: Base | None = None, **settings: Any)

   either one by one:

   .. code-block:: python

      function(..., setting_name_1=setting_name_1, setting_name_2=setting_name_2, ...)

   or using the argument name ``"settings"`` and the Pydantic model associated with the algorithm:

   .. code-block:: python

      settings = AlgorithmSettings(setting_name_1=setting_name_1, setting_name_2=setting_name_2, ...)
      function(..., settings_model=settings)





.. raw:: html

    <style>
    th {
      cursor: pointer;
    }

    th, td {
      text-align: center;
    }

    tr:hover {
        border: 1px solid black;
    }

    tr:nth-child(even) {
      background-color: #f2f2f2
    }
    </style>

    <script>
    function sortTable(n) {
      var table, rows, switching, i, x, y, shouldSwitch, dir, switchcount = 0;
      table = document.getElementById("myTable");
      switching = true;
      dir = "asc";
      while (switching) {
        switching = false;
        rows = table.rows;
        for (i = 1; i < (rows.length - 1); i++) {
          shouldSwitch = false;
          x = rows[i].getElementsByTagName("TD")[n];
          y = rows[i + 1].getElementsByTagName("TD")[n];
          if (dir == "asc") {
            if (x.innerHTML.toLowerCase() > y.innerHTML.toLowerCase()) {
              shouldSwitch= true;
              break;
            }
          } else if (dir == "desc") {
            if (x.innerHTML.toLowerCase() < y.innerHTML.toLowerCase()) {
              shouldSwitch = true;
              break;
            }
          }
        }
        if (shouldSwitch) {
          rows[i].parentNode.insertBefore(rows[i + 1], rows[i]);
          switching = true;
          switchcount ++;
        } else {
          if (switchcount == 0 && dir == "asc") {
            dir = "desc";
            switching = true;
          }
        }
      }
    }
    </script>



.. _Animation_options:

Animation
---------



Module: :class:`gemseo.post.animation`


:code:`from gemseo.settings.post import Animation_Settings`

















































































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Required settings</dt>
    <dd class="field-odd"><ul class="simple">

    <li>

**post_processing** : *gemseo.post.base_post.BasePost[typing.Any]*

The post processing object.

.. raw:: html

    </li>

    <li>

**post_processing_settings** : *<class 'gemseo.post.base_post_settings.BasePostSettings'>*

The settings for the post processing object.

.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (11.0, 11.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**first_iteration** : *<class 'int'>, optional*

The iteration to begin the animation.


By default it is set to -1.


.. raw:: html

    </li>

    <li>

**frame_rate** : *<class 'int'>, optional*

The number of iterations per time step.


By default it is set to 1.


.. raw:: html

    </li>

    <li>

**gif_file_path** : *typing.Union[str, pathlib.Path], optional*

The path to the GIF file.


By default it is set to animated_gif.


.. raw:: html

    </li>

    <li>

**n_repetitions** : *<class 'int'>, optional*

The number of times the animation is played. If ``0``, play infinitely.


By default it is set to 0.


.. raw:: html

    </li>

    <li>

**remove_frames** : *<class 'bool'>, optional*

Whether to remove the frame images after the GIF generation.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**temporary_database_path** : *typing.Union[str, pathlib.Path]*

The path to a temporary database to avoid deepcopy memory errors.If empty, deepcopy is used instead.


By default it is set to .


.. raw:: html

    </li>

    <li>

**time_step** : *<class 'float'>, optional*

The time step between two frames in milliseconds.


By default it is set to 100.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _BasicHistory_options:

BasicHistory
------------



Module: :class:`gemseo.post.basic_history`


:code:`from gemseo.settings.post import BasicHistory_Settings`







































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Required settings</dt>
    <dd class="field-odd"><ul class="simple">

    <li>

**variable_names** : *collections.abc.Sequence[str]*

The names of the variables.

.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (11.0, 6.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**normalize** : *<class 'bool'>, optional*

Whether to normalize the data.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _ConstraintsHistory_options:

ConstraintsHistory
------------------



Module: :class:`gemseo.post.constraints_history`


:code:`from gemseo.settings.post import ConstraintsHistory_Settings`













































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Required settings</dt>
    <dd class="field-odd"><ul class="simple">

    <li>

**constraint_names** : *collections.abc.Sequence[str]*

The names of the constraints.

.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**add_points** : *<class 'bool'>, optional*

Whether to add one point per iteration on the line.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (11.0, 11.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**line_style** : *<class 'str'>, optional*

The style of the line, e.g. ``"-"`` or ``"--"``. ""If ``""``, do not plot the line.


By default it is set to --.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _Correlations_options:

Correlations
------------



Module: :class:`gemseo.post.correlations`


:code:`from gemseo.settings.post import Correlations_Settings`





















































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**coeff_limit** : *<class 'float'>, optional*

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


By default it is set to 0.95.


.. raw:: html

    </li>

    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (15.0, 10.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**func_names** : *collections.abc.Sequence[str], optional*

The names of the functions to be considered. If empty, all the functions are considered.


By default it is set to ().


.. raw:: html

    </li>

    <li>

**n_plots_x** : *<class 'int'>, optional*

The number of horizontal plots.


By default it is set to 5.


.. raw:: html

    </li>

    <li>

**n_plots_y** : *<class 'int'>, optional*

The number of vertical plots.


By default it is set to 5.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _GradientSensitivity_options:

GradientSensitivity
-------------------



Module: :class:`gemseo.post.gradient_sensitivity`


:code:`from gemseo.settings.post import GradientSensitivity_Settings`















































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**compute_missing_gradients** : *<class 'bool'>, optional*

Whether to compute the gradients at the selected iteration if they were not computed by the algorithm.\n\n.. warning::\nActivating this option may add considerable computation time depending on the cost of the gradient evaluation. This option will not compute the gradients if the :class:`.OptimizationProblem` instance was imported from an HDF5 file. This option requires an :class:`.OptimizationProblem` with a gradient-based algorithm.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (10.0, 10.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**iteration** : *typing.Union[typing.Annotated[int, Lt(lt=0)], typing.Annotated[int, Gt(gt=0)], NoneType], optional*

The iteration to plot the sensitivities. Can use either positive or negative indexing, e.g. ``5`` 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.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**scale_gradients** : *<class 'bool'>, optional*

Whether to normalize each gradient w.r.t. the design variables.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _HessianHistory_options:

HessianHistory
--------------



Module: :class:`gemseo.post.hessian_history`


:code:`from gemseo.settings.post import HessianHistory_Settings`



































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (11.0, 6.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**variable_names** : *collections.abc.Sequence[str], optional*

The names of the variables.


By default it is set to ().


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _ObjConstrHist_options:

ObjConstrHist
-------------



Module: :class:`gemseo.post.obj_constr_hist`


:code:`from gemseo.settings.post import ObjConstrHist_Settings`



































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**constraint_names** : *collections.abc.Sequence[str], optional*

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


By default it is set to ().


.. raw:: html

    </li>

    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (11.0, 6.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _OptHistoryView_options:

OptHistoryView
--------------



Module: :class:`gemseo.post.opt_history_view`


:code:`from gemseo.settings.post import OptHistoryView_Settings`





















































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (11.0, 6.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**obj_max** : *typing.Optional[float], optional*

The upper limit of the *y*-axis on which the objective is plotted. This limit must be greater than or equal to the maximum value of the objective history. If ``None``, use the maximum value of the objective history.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**obj_min** : *typing.Optional[float], optional*

The lower limit of the *y*-axis on which the objective is plotted. This limit must be less than or equal to the minimum value of the objective history. If ``None``, use the minimum value of the objective history.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**obj_relative** : *<class 'bool'>, optional*

Whether the difference between the objective and its initial value is plotted instead of the objective.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**variable_names** : *collections.abc.Sequence[str], optional*

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


By default it is set to ().


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _ParallelCoordinates_options:

ParallelCoordinates
-------------------



Module: :class:`gemseo.post.parallel_coordinates`


:code:`from gemseo.settings.post import ParallelCoordinates_Settings`





























































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (10.0, 5.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _ParetoFront_options:

ParetoFront
-----------



Module: :class:`gemseo.post.pareto_front`


:code:`from gemseo.settings.post import ParetoFront_Settings`















































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (10.0, 10.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**objectives** : *collections.abc.Sequence[str], optional*

The functions names or design variables to plot. If empty, use the objective function (maybe a vector).


By default it is set to ().


.. raw:: html

    </li>

    <li>

**objectives_labels** : *collections.abc.Sequence[str], optional*

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


By default it is set to ().


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**show_non_feasible** : *<class 'bool'>, optional*

Whether to show the non-feasible points in the plot.


By default it is set to True.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _QuadApprox_options:

QuadApprox
----------



Module: :class:`gemseo.post.quad_approx`


:code:`from gemseo.settings.post import QuadApprox_Settings`







































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Required settings</dt>
    <dd class="field-odd"><ul class="simple">

    <li>

**function** : *<class 'str'>*

The function name to build the quadratic approximation.

.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (9.0, 6.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**func_index** : *typing.Optional[typing.Annotated[int, Ge(ge=0)]], 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.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _RadarChart_options:

RadarChart
----------



Module: :class:`gemseo.post.radar_chart`


:code:`from gemseo.settings.post import RadarChart_Settings`















































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**constraint_names** : *collections.abc.Sequence[str], optional*

The names of the constraints. If empty, use all the constraints.


By default it is set to ().


.. raw:: html

    </li>

    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (6.4, 4.8).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**iteration** : *typing.Optional[int], optional*

Either an iteration in :math:`\{-N,\ldots,-1,1,\ldots,N\}` or ``None`` for the iteration at which the optimum is located, where :math:`N` is the length of the database.


By default it is set to None.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**show_names_radially** : *<class '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.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _Robustness_options:

Robustness
----------



Module: :class:`gemseo.post.robustness`


:code:`from gemseo.settings.post import Robustness_Settings`



































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (8.0, 5.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**stddev** : *<class '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.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _SOM_options:

SOM
---



Module: :class:`gemseo.post.som`


:code:`from gemseo.settings.post import SOM_Settings`















































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**annotate** : *<class 'bool'>, optional*

Whether to show the label of the neuron value.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (12.0, 18.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**n_x** : *<class 'int'>, optional*

The number of grids in x.


By default it is set to 4.


.. raw:: html

    </li>

    <li>

**n_y** : *<class 'int'>, optional*

The number of grids in y.


By default it is set to 4.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _ScatterPlotMatrix_options:

ScatterPlotMatrix
-----------------



Module: :class:`gemseo.post.scatter_plot_matrix`


:code:`from gemseo.settings.post import ScatterPlotMatrix_Settings`









































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (10.0, 10.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**filter_non_feasible** : *<class 'bool'>, optional*

Whether to remove the non-feasible points from the data.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**variable_names** : *collections.abc.Sequence[str], optional*

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


By default it is set to ().


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _TopologyView_options:

TopologyView
------------



Module: :class:`gemseo.post.topology_view`


:code:`from gemseo.settings.post import TopologyView_Settings`



















































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Required settings</dt>
    <dd class="field-odd"><ul class="simple">

    <li>

**n_x** : *<class 'int'>*

The number of elements in the horizontal direction.

.. raw:: html

    </li>

    <li>

**n_y** : *<class 'int'>*

The number of elements in the vertical direction.

.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (6.4, 4.8).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**iterations** : *typing.Union[int, collections.abc.Sequence[int]], optional*

The iterations of the optimization history. If empty, the last iteration is taken.


By default it is set to ().


.. raw:: html

    </li>

    <li>

**observable** : *<class 'str'>*

The name of the observable to be plotted. It should be of size ``n_x*n_y``.


By default it is set to .


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>



.. _VariableInfluence_options:

VariableInfluence
-----------------



Module: :class:`gemseo.post.variable_influence`


:code:`from gemseo.settings.post import VariableInfluence_Settings`





















































































.. raw:: html

    <dl class="field-list simple">
    <dt class="field-odd">Optional settings</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**absolute_value** : *<class 'bool'>, optional*

Whether to plot the absolute value of the influence.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**directory_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional*

The width and height of the figure in inches, e.g. `(w, h)`.


By default it is set to (11.0, 11.0).


.. raw:: html

    </li>

    <li>

**file_extension** : *<class 'str'>*

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_name** : *<class 'str'>*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**file_path** : *typing.Union[pathlib.Path, str]*

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


By default it is set to .


.. raw:: html

    </li>

    <li>

**level** : *<class '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.


.. raw:: html

    </li>

    <li>

**log_scale** : *<class 'bool'>, optional*

Whether to set the y-axis as log scale.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**save** : *<class 'bool'>, optional*

Whether to save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**save_var_files** : *<class 'bool'>, optional*

Whether to save the influential variables indices to a NumPy file.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**show** : *<class 'bool'>, optional*

Whether to display the figure.


By default it is set to False.


.. raw:: html

    </li>

    </ul>
    </dd>
    </dl>