robokudo.vis.visualizer
=======================

.. py:module:: robokudo.vis.visualizer


Classes
-------

.. autoapisummary::

   robokudo.vis.visualizer.Visualizer


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

.. py:class:: Visualizer(pipeline: robokudo.pipeline.Pipeline, shared_visualizer_state=None)

   Bases: :py:obj:`object`


   .. py:class:: Observable

      .. py:attribute:: _observers
         :value: []



      .. py:method:: register_observer(observer)


      .. py:method:: notify_observers(*args, **kwargs)



   .. py:class:: Observer

      .. py:method:: notify(observable, *args, **kwargs)



   .. py:class:: SharedState

      Bases: :py:obj:`Observable`


      A SharedState for single-view annotators.
      They can switch between all Annotators to visualize a single 'active' Annotator.

      An Observer pattern is used to notify Visualizers that the to-be-shown content has to be updated due to
      processed inputs. It is NOT used for new data.


      .. py:attribute:: active_annotator
         :value: None



      .. py:attribute:: active_annotator_i
         :value: 0




   .. py:attribute:: instances
      :value: []



   .. py:attribute:: pipeline


   .. py:attribute:: indicate_termination_var
      :value: False



   .. py:attribute:: shared_visualizer_state
      :value: None



   .. py:attribute:: update_output
      :value: True



   .. py:attribute:: new_data
      :value: False



   .. py:attribute:: rk_logger
      :value: None



   .. py:method:: pre_tick()


   .. py:method:: tick()

      The main method of each Visualizer. It is responsible for creating the necessary outputs that
      the Visualizer should show.



   .. py:method:: post_tick()


   .. py:method:: static_post_tick()
      :staticmethod:


      This method is intended to be only called once per Visualizer Type, independent of the amount of same-typed Visualizers



   .. py:method:: new_visualizer_instance(pipeline: robokudo.pipeline.Pipeline, shared_visualizer_state=None)
      :classmethod:



   .. py:method:: clear_visualizer_instances()
      :staticmethod:



   .. py:method:: insert_input()


   .. py:method:: activate_update_output()


   .. py:method:: new_data_available()

      The caller tells this Visualizer, that new data is available for retrieval.



   .. py:method:: indicate_termination()

      This indicates the caller if this Visualizer thinks the program execution should be terminated.



   .. py:method:: get_unique_types_of_visualizer_instances()
      :staticmethod:



   .. py:method:: update_output_flag_for_new_data() -> None

      If this Visualizer gets new data, set the update flag for rendering purposes accordingly.



   .. py:method:: get_visualized_annotator_outputs_for_pipeline() -> robokudo.annotators.outputs.AnnotatorOutputs