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

Options for Post-processing algorithms
======================================


.. _BasicHistory_options:

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

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





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**data_list** (*Sequence[str]*)

The names of the variables.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, 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`





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**constraints_list** (*Sequence[str]*)

The names of the constraints.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>



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


.. _Correlations_options:

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

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





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**coeff_limit** (*float*)

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


By default it is set to 0.95.


.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**func_names** (*Optional[Sequence[str]]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**n_plots_x** (*int*)

The number of horizontal plots.


By default it is set to 5.


.. raw:: html

    </li>


    <li>

**n_plots_y** (*int*)

The number of vertical plots.


By default it is set to 5.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, 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`





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**iteration** (*int*)

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


By default it is set to -1.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**scale_gradients** (*bool*)

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


By default it is set to False.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>



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


.. _KMeans_options:

KMeans
------

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





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Union[str,Path]]*)




By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)




By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)




By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)




By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)




By default it is set to None.


.. raw:: html

    </li>


    <li>

**n_clusters** (*int*)

The number of clusters.


By default it is set to 5.


.. raw:: html

    </li>


    <li>

**save** (*bool*)




By default it is set to True.


.. raw:: html

    </li>


    <li>

**self** (*OptPostProcessorOptionType*)





.. raw:: html

    </li>


    <li>

**show** (*bool*)




By default it is set to False.


.. raw:: html

    </li>



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


.. _ObjConstrHist_options:

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

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





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**constr_names** (*Optional[Sequence[str]]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, 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`





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**obj_max** (*Optional[float]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**obj_min** (*Optional[float]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**obj_relative** (*bool*)

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


By default it is set to False.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**variables_names** (*Optional[Sequence[str]]*)

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


By default it is set to None.


.. raw:: html

    </li>



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


.. _ParallelCoordinates_options:

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

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





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**self** (*OptPostProcessorOptionType*)





.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, 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`





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**objectives** (*Optional[Sequence[str]]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**objectives_labels** (*Optional[Sequence[str]]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**show_non_feasible** (*bool*)

If True, 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`





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**func_index** (*Optional[int]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**function** (*str*)

The function name to build the quadratic approximation.



.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, 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`





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**constraints_list** (*Sequence[str]*)

The names of the constraints.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**iteration** (*int*)

The number of iteration to post-process.


By default it is set to -1.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>



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


.. _Robustness_options:

Robustness
----------

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





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**stddev** (*float*)

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


By default it is set to 0.01.


.. raw:: html

    </li>



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


.. _SOM_options:

SOM
---

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





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**annotate** (*bool*)

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


By default it is set to False.


.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**n_x** (*int*)

The number of grids in x.


By default it is set to 4.


.. raw:: html

    </li>


    <li>

**n_y** (*int*)

The number of grids in y.


By default it is set to 4.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>



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


.. _ScatterPlotMatrix_options:

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

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





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**filter_non_feasible** (*bool*)

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


By default it is set to False.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**variables_list** (*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>


.. _VariableInfluence_options:

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

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





Here are the options available in |g|:

.. 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">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****options** (*OptPostProcessorOptionType*)

The options of the post-processor.



.. raw:: html

    </li>


    <li>

**absolute_value** (*bool*)

If True, plot the absolute value of the influence.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**directory_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**fig_size** (*Optional[Tuple[float,*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_extension** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_name** (*Optional[str]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**file_path** (*Optional[Path]*)

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


By default it is set to None.


.. raw:: html

    </li>


    <li>

**log_scale** (*bool*)

If True, use a logarithmic scale.


By default it is set to False.


.. raw:: html

    </li>


    <li>

**quantile** (*float*)

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


By default it is set to 0.99.


.. raw:: html

    </li>


    <li>

**save** (*bool*)

If True, save the figure.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**save_var_files** (*bool*)

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


By default it is set to False.


.. raw:: html

    </li>


    <li>

**show** (*bool*)

If True, display the figure.


By default it is set to False.


.. raw:: html

    </li>



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