..
   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 algorithms may require the :ref:`installation <installation>` of |g| with :ref:`all its features <dependencies>`
    and some others may depend on :ref:`plugins <plugins>`.

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

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



.. _BasicHistory_options:

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



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />





































































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

    <li>

**variable_names** : *Sequence[str]*

The names of the variables.

.. raw:: html

    </li>

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



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


    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _Compromise_options:

Compromise
----------


.. note::
    The plugin `gemseo_pymoo <https://gitlab.com/gemseo/dev/gemseo-pymoo>`_ is required.


Module: :class:`gemseo_pymoo.post.compromise`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />





































































































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


    <li>

****scalar_options** : *Any*

The keyword arguments for the scalarization function.



.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**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 <https://en.wikipedia.org/wiki/Euclidean_distance>`_ ) of the vector represented by the arrow.


By default it is set to False.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**plot_legend** : *bool, optional*

Whether to show the legend.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**scalar_name** : *str, optional*

The name of the scalarization function to use.


By default it is set to weighted-sum.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _ConstraintsHistory_options:

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



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />





































































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

    <li>

**constraint_names** : *Sequence[str]*

The names of the constraints.

.. raw:: html

    </li>

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



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


    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _Correlations_options:

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



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

























































































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


    <li>

**coeff_limit** : *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** : *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.


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**n_plots_x** : *int, optional*

The number of horizontal plots.


By default it is set to 5.


.. raw:: html

    </li>

    <li>

**n_plots_y** : *int, optional*

The number of vertical plots.


By default it is set to 5.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _GradientSensitivity_options:

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



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />













































































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


    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**scale_gradients** : *bool, optional*

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


By default it is set to False.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _HighTradeOff_options:

HighTradeOff
------------


.. note::
    The plugin `gemseo_pymoo <https://gitlab.com/gemseo/dev/gemseo-pymoo>`_ is required.


Module: :class:`gemseo_pymoo.post.high_tradeoff`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

























































































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


    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**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 <https://en.wikipedia.org/wiki/Euclidean_distance>`_ ) of the vector represented by the arrow.


By default it is set to False.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**plot_legend** : *bool, optional*

Whether to show the legend.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****high_tradeoff_options** : *Any*

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



.. raw:: html

    </li>

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



.. _KMeans_options:

KMeans
------



Module: :class:`gemseo.post.kmeans`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />







































































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


    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**n_clusters** : *int, optional*

The number of clusters.


By default it is set to 5.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The post-processor options.



.. raw:: html

    </li>

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



.. _MultiObjectiveDiagram_options:

MultiObjectiveDiagram
---------------------


.. note::
    The plugin `gemseo_pymoo <https://gitlab.com/gemseo/dev/gemseo-pymoo>`_ is required.


Module: :class:`gemseo_pymoo.post.core.multi_objective_diagram`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />





























































































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

    <li>

**diagram** : *str*

The type of the diagram to be created.

.. raw:: html

    </li>

    <li>

**scalar_name** : *str*

The name of the scalarization function to use.

.. raw:: html

    </li>

    <li>

**weights** : *ndarray*

The weights for the scalarization function.

.. raw:: html

    </li>

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



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


    <li>

****scalar_options** : *Any*

The keyword arguments for the scalarization function.



.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**normalize_each_objective** : *bool, optional*

Whether the objectives should be normalized.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _ObjConstrHist_options:

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



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />







































































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


    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _OptHistoryView_options:

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



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

























































































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


    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**obj_relative** : *bool, optional*

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


By default it is set to False.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _ParallelCoordinates_options:

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



Module: :class:`gemseo.post.para_coord`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

































































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


    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The post-processor options.



.. raw:: html

    </li>

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



.. _ParetoFront_options:

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



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />



















































































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


    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**show_non_feasible** : *bool, optional*

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


By default it is set to True.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _Petal_options:

Petal
-----


.. note::
    The plugin `gemseo_pymoo <https://gitlab.com/gemseo/dev/gemseo-pymoo>`_ is required.


Module: :class:`gemseo_pymoo.post.petal`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

















































































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

    <li>

**scalar_name** : *str*

The name of the scalarization function to use.

.. raw:: html

    </li>

    <li>

**weights** : *ndarray*

The weights for the scalarization function.

.. raw:: html

    </li>

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



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


    <li>

****scalar_options** : *Any*

The keyword arguments for the scalarization function.



.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _QuadApprox_options:

QuadApprox
----------



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />











































































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

    <li>

**function** : *str*

The function name to build the quadratic approximation.

.. raw:: html

    </li>

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



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


    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _Radar_options:

Radar
-----


.. note::
    The plugin `gemseo_pymoo <https://gitlab.com/gemseo/dev/gemseo-pymoo>`_ is required.


Module: :class:`gemseo_pymoo.post.radar`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />























































































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

    <li>

**scalar_name** : *str*

The name of the scalarization function to use.

.. raw:: html

    </li>

    <li>

**weights** : *ndarray*

The weights for the scalarization function.

.. raw:: html

    </li>

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



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


    <li>

****scalar_options** : *Any*

The keyword arguments for the scalarization function.



.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**normalize_each_objective** : *bool, optional*

Whether the objectives should be normalized.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _RadarChart_options:

RadarChart
----------



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />



















































































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


    <li>

**constraint_names** : *Iterable[str] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**iteration** : *int | RadarChart.OPTIMUM, optional*

Either a database index in :math:`-N+1,\ldots,-1,0,1,`ldots,N-1` or the tag :attr:`.OPTIMUM` for the database index at which the optimum is located, where :math:`N` is the length of the database.


By default it is set to opt.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _Robustness_options:

Robustness
----------



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />







































































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


    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _SOM_options:

SOM
---



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />



















































































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


    <li>

**annotate** : *bool, optional*

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


By default it is set to False.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**n_x** : *int, optional*

The number of grids in x.


By default it is set to 4.


.. raw:: html

    </li>

    <li>

**n_y** : *int, optional*

The number of grids in y.


By default it is set to 4.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _ScatterPareto_options:

ScatterPareto
-------------


.. note::
    The plugin `gemseo_pymoo <https://gitlab.com/gemseo/dev/gemseo-pymoo>`_ is required.


Module: :class:`gemseo_pymoo.post.scatter_pareto`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />





































































































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


    <li>

****scatter_options** : *Any*

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



.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**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 <https://en.wikipedia.org/wiki/Euclidean_distance>`_ ) of the vector represented by the arrow.


By default it is set to False.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**plot_legend** : *bool, optional*

Whether to show the legend.


By default it is set to True.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _ScatterPlotMatrix_options:

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



Module: :class:`gemseo.post.scatter_mat`





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />











































































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

    <li>

**variable_names** : *Sequence[str]*

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

.. raw:: html

    </li>

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



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


    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**filter_non_feasible** : *bool, optional*

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


By default it is set to False.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**show** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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



.. _VariableInfluence_options:

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



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





.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

























































































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


    <li>

**absolute_value** : *bool, optional*

Whether to plot the absolute value of the influence.


By default it is set to False.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**fig_size** : *tuple[float, float] | None, optional*

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


By default it is set to None.


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

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


.. raw:: html

    </li>

    <li>

**log_scale** : *bool, optional*

Whether to set the y-axis as log scale.


By default it is set to False.


.. raw:: html

    </li>

    <li>

**save** : *bool, optional*

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>

    <li>

**save_var_files** : *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** : *bool, optional*

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>

    <li>

****options** : *OptPostProcessorOptionType*

The options of the post-processor.



.. raw:: html

    </li>

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