``viewOptimizationResults``
====================================================

.. py:module:: optimeed.visualize.viewOptimizationResults


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

Classes
~~~~~~~

.. autoapisummary::

   optimeed.visualize.viewOptimizationResults._OptiProjectLoader
   optimeed.visualize.viewOptimizationResults.ViewOptimizationResults




.. py:class:: _OptiProjectLoader(foldername, kwargsPlot=None)


   A loader for an opti project.

   .. py:method:: get_devices() -> optimeed.core.ListDataStruct_Interface


   .. py:method:: get_logopti() -> optimeed.core.ListDataStruct_Interface


   .. py:method:: get_convergence()


   .. py:method:: get_optisettings()


   .. py:method:: get_kwargs()


   .. py:method:: get_nbr_objectives()



.. py:class:: ViewOptimizationResults


   Convenience class to display the results of an optimization

   .. py:method:: add_opti_project(foldername, kwargsPlot=None)

      Add an opti project to visualize.

      :param foldername: the folder containing the saved files. (as string)
      :param kwargsPlot: Check kgwargs `~optimeed.core.graphs.Data`


   .. py:method:: get_data_link() -> optimeed.core.LinkDataGraph

      Return the object :class:`~optimeed.core.linkDataGraph.LinkDataGraph`


   .. py:method:: display_graphs_pareto_mode(theActionsOnClick=None, kwargs_common=None, keep_alive=True, max_nb_points_convergence=None, light_background=False)

      Same as meth:`display_graphs`, but only displays the points belonging to the pareto front.

      :param theActionsOnClick: list of actions to perform when a graph is clicked
      :param kwargs_common: plot options (from Data class) to apply to all the graphs (ex: {"is_scattered": True}).
      :param keep_alive: if set to true, this method will be blocking. Otherwise you should manually call start_qt_mainloop().
      :param max_nb_points_convergence: maximum number of points in the graph that displays the convergence. Put None if performance is not an issue.
      :param light_background: boolean, True or False for White or Black background color in graphs
      :return: widget_graphs_visual for the log opti, widget_graphs_visual for the convergence (:class:`~widget_graphs_visual`)


   .. py:method:: display_graphs(theActionsOnClick=None, kwargs_common=None, keep_alive=True, max_nb_points_convergence=None, light_background=False)

      Generates the optimization graphs.

      :param theActionsOnClick: list of actions to perform when a graph is clicked
      :param kwargs_common: plot options (from Data class) to apply to all the graphs (ex: {"is_scattered": True}).
      :param keep_alive: if set to true, this method will be blocking. Otherwise you should manually call start_qt_mainloop().
      :param max_nb_points_convergence: maximum number of points in the graph that displays the convergence. Put None if performance is not an issue.
      :param light_background: boolean, True or False for White or Black background color in graphs
      :return: widget_graphs_visual for the log opti, widget_graphs_visual for the convergence (:class:`~widget_graphs_visual`)