``displayOptimization``
================================================

.. py:module:: optimeed.visualize.displayOptimization


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

Classes
~~~~~~~

.. autoapisummary::

   optimeed.visualize.displayOptimization.OptimizationDisplayer



Functions
~~~~~~~~~

.. autoapisummary::

   optimeed.visualize.displayOptimization.check_if_must_plot
   optimeed.visualize.displayOptimization.run_optimization_displayer



.. py:function:: check_if_must_plot(elem)


.. py:function:: run_optimization_displayer(*args, **kwargs)


.. py:class:: OptimizationDisplayer(theOptiParameters, theOptiHistoric, additionalWidgets=None, light_background=False)


   Bases: :py:obj:`optimeed.core.Option_class`

   Class used to display optimization process in real time

   .. py:attribute:: signal_optimization_over

      

   .. py:attribute:: SHOW_CONSTRAINTS
      :value: 0

      

   .. py:method:: set_actionsOnClick(theList)

      Set actions to perform on click, list of :class:`~optimeed.visualize.gui.widgets.widget_graphs_visual.on_graph_click_interface`


   .. py:method:: generate_optimizationGraphs()

      Generates the optimization graphs.
      :return: :class:`~optimeed.core.graphs.Graphs`, :class:`~optimeed.core.linkDataGraph.LinkDataGraph`, :class:'~optimeed.visulaize.gui.widgets.widget_graphs_visual.widget_graphs_visual


   .. py:method:: __change_appearance_violate_constraints()


   .. py:method:: __refresh()


   .. py:method:: start_autorefresh(timer_autosave)


   .. py:method:: stop_autorefresh()


   .. py:method:: __set_graphs_disposition()

      Set nicely the graphs disposition


   .. py:method:: launch_optimization(args_opti, kwargs_opti, refresh_time=0.1, max_nb_points_convergence=100)

      Perform the optimization and spawn the convergence graphs afterwards.
      :param args_opti: arguments (as list) destined to launch the optimization
      :param kwargs_opti: keywords arguments (as dict) destined to launch the optimization
      :param refresh_time: float indicating the refresh time of the graphs. If it becomes laggy -> use a higher one.
      :param max_nb_points_convergence: maximum number of points in the graph that displays the convergence. Put None if performance is not an issue.


   .. py:method:: close_windows()


   .. py:method:: display_graphs(theGraphs)


   .. py:method:: create_main_window()

      From the widgets and the actions on click, spawn a window and put a gui around widgetsGraphsVisual.