:py:mod:`ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper`
========================================================================

.. py:module:: ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper


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

Classes
~~~~~~~

.. autoapisummary::

   ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper.TikzAnchorNames
   ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper.TikzRelativePositions
   ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper.TikzEdge
   ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper.ForwardEdge
   ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper.BackwardEdge
   ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper.IntermediateEdge
   ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper.TikzNode
   ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper.TikzMatrixRow
   ethos_penalps.post_processing.tikz_visualizations.tikz_wrapper.TikzMatrix




.. py:class:: TikzAnchorNames


   .. py:attribute:: south
      :type: str
      :value: '.south'

      

   .. py:attribute:: south_west
      :type: str
      :value: '.south west'

      

   .. py:attribute:: north
      :type: str
      :value: '.north'

      

   .. py:attribute:: east
      :type: str
      :value: '.east'

      

   .. py:attribute:: west
      :type: str
      :value: '.west'

      


.. py:class:: TikzRelativePositions


   .. py:attribute:: above
      :type: str
      :value: 'above= of '

      

   .. py:attribute:: below
      :type: str
      :value: 'below= of '

      

   .. py:attribute:: right
      :type: str
      :value: 'right= of '

      

   .. py:attribute:: left
      :type: str
      :value: 'left= of '

      


.. py:class:: TikzEdge


   .. py:attribute:: start_node_name
      :type: str

      

   .. py:attribute:: target_node_name
      :type: str

      

   .. py:attribute:: edge_style
      :type: str
      :value: ''

      

   .. py:attribute:: edge_options
      :type: str
      :value: ''

      

   .. py:method:: create_tikz_string(add_line_break: bool = True) -> str



.. py:class:: ForwardEdge


   Bases: :py:obj:`TikzEdge`

   .. py:attribute:: edge_style
      :type: str
      :value: '->'

      


.. py:class:: BackwardEdge


   Bases: :py:obj:`TikzEdge`

   .. py:attribute:: edge_style
      :type: str
      :value: '<-'

      


.. py:class:: IntermediateEdge


   Bases: :py:obj:`TikzEdge`

   .. py:attribute:: edge_style
      :type: str
      :value: '-'

      


.. py:class:: TikzNode


   .. py:attribute:: name_to_display
      :type: str

      

   .. py:attribute:: unique_identification_name
      :type: str

      

   .. py:attribute:: node_options
      :type: str

      

   .. py:method:: create_node_string(add_line_break: bool = False) -> str


   .. py:method:: create_node_below_of(unique_tikz_object_name: str, add_line_break: bool = False) -> str


   .. py:method:: create_node_above_of(unique_tikz_object_name: str, add_line_break: bool = False) -> str


   .. py:method:: create_node_left_of(unique_tikz_object_name: str, add_line_break: bool = False) -> str


   .. py:method:: create_node_right_of(unique_tikz_object_name: str, add_line_break: bool = False) -> str



.. py:class:: TikzMatrixRow


   .. py:attribute:: name_to_display
      :type: str

      

   .. py:attribute:: unique_identification_name
      :type: str

      

   .. py:attribute:: list_of_tikz_nodes
      :type: list[TikzNode]

      

   .. py:method:: create_row_string(add_line_break: bool = True) -> str



.. py:class:: TikzMatrix(list_of_tikz_matrix_rows: list[TikzMatrixRow], unique_tikz_name: str, relative_node_name: str | None = None, relative_node_anchor: str = TikzAnchorNames.south, relative_position: str = TikzRelativePositions.below)


   .. py:method:: add_option(option_string: str)


   .. py:method:: create_tikz_string() -> str


   .. py:method:: create_matrix_from_rows() -> str


   .. py:method:: convert_list_rows_to_list_columns()


   .. py:method:: create_preamble()


   .. py:method:: create_matrix_position_option() -> str