:py:mod:`mlair.plotting.tracker_plot`
=====================================

.. py:module:: mlair.plotting.tracker_plot


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

Classes
~~~~~~~

.. autoapisummary::

   mlair.plotting.tracker_plot.TrackObject
   mlair.plotting.tracker_plot.TrackChain
   mlair.plotting.tracker_plot.TrackPlot




.. py:class:: TrackObject(name: Union[List[str], str], stage: str)

   A TrackObject can be used to create simple chains of objects.

   :param name: string or list of strings with a name describing the track object
   :param stage: additional meta information (can be used to highlight different blocks inside a chain)

   .. py:method:: __repr__(self)

      Return repr(self).


   .. py:method:: x(self)
      :property:

      Get x value.


   .. py:method:: y(self)
      :property:

      Get y value.


   .. py:method:: add_precursor(self, precursor: TrackObject)

      Add a precursory track object.


   .. py:method:: add_successor(self, successor: TrackObject)

      Add a successive track object.



.. py:class:: TrackChain(track_list)

   .. py:method:: get_all_scopes(self, track_list) -> Dict

      Return dictionary with all distinct variables as keys and its unique scopes as values.


   .. py:method:: get_all_dims(scopes)
      :staticmethod:


   .. py:method:: create_track_chain(self)


   .. py:method:: _create_track_chain(self, control, sorted_track_dict, stage)


   .. py:method:: _update_control(control, variable, scope, tr_obj)
      :staticmethod:


   .. py:method:: _add_track_object(track_objects, tr_obj, prev_obj)
      :staticmethod:


   .. py:method:: _add_precursor(self, track_objects, tr_obj, prev_obj)


   .. py:method:: _add_set_object(self, track_objects, tr_obj, control_obj)


   .. py:method:: _recursive_decent(self, scope, control_obj_var)


   .. py:method:: _add_get_object(self, track_objects, tr_obj, control_obj, control, scope, variable)


   .. py:method:: control_dict(scopes)
      :staticmethod:

      Create empty control dictionary with variables and scopes as keys and None as default for all values.


   .. py:method:: clean_control(control)
      :staticmethod:


   .. py:method:: get_unique_scopes(track_list: List[Dict]) -> List[str]
      :staticmethod:

      Get list with all unique elements from input including general scope if missing.



.. py:class:: TrackPlot(tracker_list, sparse_conn_mode=True, plot_folder: str = '.', skip_run_env=True, plot_name=None)

   .. py:method:: _plot(self, track_chain_dict, sparse_conn_mode, skip_run_env, plot_folder, plot_name=None)


   .. py:method:: line(self, start_x, end_x, y, color='darkgrey')

      Draw grey horizontal connection line from start_x to end_x on y-pos.


   .. py:method:: step(self, start_x, end_x, start_y, end_y, color='black')

      Draw black connection step line from start_xy to end_xy. Step is taken shortly before end position.


   .. py:method:: rect(self, x, y, method='get')

      Draw rectangle with lower left at (x,y), size equal to width/height and label/color according to method.


   .. py:method:: set_ypos_anchor(self, scopes, dims)


   .. py:method:: plot_track_chain(self, chain, y_pos, x_pos=0, prev=None, stage=None, sparse_conn_mode=False)


   .. py:method:: add_variable_names(self)


   .. py:method:: add_stages(self, vlines, stages)


   .. py:method:: create_track_chain_plot(self, track_chain_dict, sparse_conn_mode=True, skip_run_env=True)


   .. py:method:: set_lims(self)