``displaySensitivity``
===============================================

.. py:module:: optimeed.visualize.displaySensitivity


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   optimeed.visualize.displaySensitivity.SensitivityDisplayer



Functions
~~~~~~~~~

.. autoapisummary::

   optimeed.visualize.displaySensitivity.analyse_sobol_plot_convergence
   optimeed.visualize.displaySensitivity.analyse_sobol_plot_indices
   optimeed.visualize.displaySensitivity.analyse_sobol_plot_2ndOrder_indices



.. py:function:: analyse_sobol_plot_convergence(theDict, title='', hold=True)

   Plot convergence of the sobol indices.

   :param theDict: Dictionary containing sobol indices
   :param title: Title of the convergence window
   :param hold: If true, this function will be blocking (otherwise use start_qt_mainloop)
   :return: window containing convergence graphs


.. py:function:: analyse_sobol_plot_indices(SA_library: optimeed.consolidate.SensitivityAnalysis_LibInterface, title='', hold=True)

   ¨Plot first and total order sobol indices.

   :param SA_library: The library used for computing the sobol indices
   :param title: Title of the window
   :param hold: If true, this function will be blocking (otherwise use plt.show())
   :return:


.. py:function:: analyse_sobol_plot_2ndOrder_indices(SA_library: optimeed.consolidate.SensitivityAnalysis_LibInterface, title='', hold=True)

   ¨Plot second order sobol indices. Args and kwargs are the same as analyse_sobol_plot_indices


.. py:class:: SensitivityDisplayer(theLibrary: type(SensitivityAnalysis_LibInterface))


   Bases: :py:obj:`PyQt5.QtWidgets.QMainWindow`

   GUI to display a sensitivity analysis.

   .. py:method:: add_study(theCollection, theParameters, name)

      Add sensitivity study to the GUI

      :param theCollection: Results of the sensitivity study
      :param theParameters: Parameters of the sensitivity study
      :param name: Name (for the GUI) of the sensitivity study
      :return:


   .. py:method:: _set_study(index)


   .. py:method:: _get_sobol_indices()


   .. py:method:: _get_S1_conv()


   .. py:method:: _get_ST_conv()


   .. py:method:: get_SA(theParameters, theObjectives)


   .. py:method:: set_SA(theSA)


   .. py:method:: get_attribute_selected()


   .. py:method:: run()
      :staticmethod: