:py:mod:`desdeo_emo.utilities.plotlyanimate`
============================================

.. py:module:: desdeo_emo.utilities.plotlyanimate


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


Functions
~~~~~~~~~

.. autoapisummary::

   desdeo_emo.utilities.plotlyanimate.animate_init_
   desdeo_emo.utilities.plotlyanimate.animate_next_
   desdeo_emo.utilities.plotlyanimate.animate_2d_init_
   desdeo_emo.utilities.plotlyanimate.animate_2d_next_
   desdeo_emo.utilities.plotlyanimate.animate_3d_init_
   desdeo_emo.utilities.plotlyanimate.animate_3d_next_
   desdeo_emo.utilities.plotlyanimate.animate_parallel_coords_init_
   desdeo_emo.utilities.plotlyanimate.animate_parallel_coords_next_
   desdeo_emo.utilities.plotlyanimate.test
   desdeo_emo.utilities.plotlyanimate.test2



.. py:function:: animate_init_(data: Union[numpy.ndarray, pandas.DataFrame, list], filename: str) -> dict

   Plot the first (or zeroth) iteration of a population.

   Intended as a frames object. Plots Scatter for 2D and 3D data.
   Plots parallel coordinate plot for higher dimensional data.

   :param data: Contains the data to be plotted. Each row is an individual's objective values.
   :type data: Union[np.ndarray, pd.DataFrame, list]
   :param filename: Contains the name of the file to which the plot is saved.
   :type filename: str

   :returns: Plotly figure object
   :rtype: dict


.. py:function:: animate_next_(data: Union[numpy.ndarray, pandas.DataFrame, list], figure: dict, filename: str, generation: int = None) -> dict

   Plot the next set of individuals in an animation.

   Plots scatter for 2D and 3D data, parallel coordinate plot for 4D and up.

   :param data: The objective values to be plotted
   :type data: Union[np.ndarray, pd.DataFrame, list]
   :param figure: Plotly figure object compatible dict
   :type figure: dict
   :param filename: Name of the file to which the plot is saved
   :type filename: str
   :param generation: Iteration Number
   :type generation: int

   :returns: Plotly Figure Object
   :rtype: dict


.. py:function:: animate_2d_init_(data: Union[numpy.ndarray, pandas.DataFrame, list], filename: str) -> dict

   Initiate a 2D scatter animation.

   Only for 2D data.

   :param data: Objective values
   :type data: Union[np.ndarray, pd.DataFrame, list]
   :param filename: Name of the file to which plot is saved
   :type filename: str

   :returns: Plotly Figure Object
   :rtype: dict


.. py:function:: animate_2d_next_(data: Union[numpy.ndarray, pandas.DataFrame, list], figure: dict, filename: str, generation: int) -> dict

   Plot the next set of individuals in a 2D scatter animation.

   :param data: The objective values to be plotted
   :type data: Union[np.ndarray, pd.DataFrame, list]
   :param figure: Plotly figure object compatible dict
   :type figure: dict
   :param filename: Name of the file to which the plot is saved
   :type filename: str
   :param generation: Iteration Number
   :type generation: int

   :returns: Plotly Figure Object
   :rtype: dict


.. py:function:: animate_3d_init_(data: Union[numpy.ndarray, pandas.DataFrame, list], filename: str) -> dict

   Plot the first (or zeroth) iteration of a population.

   Intended as a frames object. Plots Scatter 3D data.

   :param data: Contains the data to be plotted. Each row is an individual's objective values.
   :type data: Union[np.ndarray, pd.DataFrame, list]
   :param filename: Contains the name of the file to which the plot is saved.
   :type filename: str

   :returns: Plotly figure object
   :rtype: dict


.. py:function:: animate_3d_next_(data: Union[numpy.ndarray, pandas.DataFrame, list], figure: dict, filename: str, generation: int) -> dict

   Plot the next set of individuals in an animation.

   Plots scatter for 3D data.

   :param data: The objective values to be plotted
   :type data: Union[np.ndarray, pd.DataFrame, list]
   :param figure: Plotly figure object compatible dict
   :type figure: dict
   :param filename: Name of the file to which the plot is saved
   :type filename: str
   :param generation: Iteration Number
   :type generation: int

   :returns: Plotly Figure Object
   :rtype: dict


.. py:function:: animate_parallel_coords_init_(data: Union[numpy.ndarray, pandas.DataFrame, list], filename: str) -> dict

   Plot the first (or zeroth) iteration of a population.

   Intended as a frames object. Plots parallel coordinate plot for >3D data.

   :param data: Contains the data to be plotted. Each row is an individual's objective values.
   :type data: Union[np.ndarray, pd.DataFrame, list]
   :param filename: Contains the name of the file to which the plot is saved.
   :type filename: str

   :returns: Plotly figure object
   :rtype: dict


.. py:function:: animate_parallel_coords_next_(data: Union[numpy.ndarray, pandas.DataFrame, list], figure: dict, filename: str, generation: int) -> dict

   Plot the next set of individuals in an animation.

   Plots parallel coordinate plot for 4D and up.

   :param data: The objective values to be plotted
   :type data: Union[np.ndarray, pd.DataFrame, list]
   :param figure: Plotly figure object compatible dict
   :type figure: dict
   :param filename: Name of the file to which the plot is saved
   :type filename: str
   :param generation: Iteration Number
   :type generation: int

   :returns: Plotly Figure Object
   :rtype: dict


.. py:function:: test()


.. py:function:: test2()