``tikzTranslator``
======================================

.. py:module:: optimeed.core.tikzTranslator


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


Functions
~~~~~~~~~

.. autoapisummary::

   optimeed.core.tikzTranslator.format_escape_char
   optimeed.core.tikzTranslator.convert_linestyle
   optimeed.core.tikzTranslator.find_all_colors
   optimeed.core.tikzTranslator.convert_marker
   optimeed.core.tikzTranslator.do_preamble
   optimeed.core.tikzTranslator.do_generate_figure
   optimeed.core.tikzTranslator.do_specific_axis_options
   optimeed.core.tikzTranslator.do_specific_trace_options
   optimeed.core.tikzTranslator.export_to_tikz_groupGraphs
   optimeed.core.tikzTranslator.do_preamble3D
   optimeed.core.tikzTranslator.format_Griddata
   optimeed.core.tikzTranslator.format_scatterdata
   optimeed.core.tikzTranslator.export_to_tikz_contour_plot



Attributes
~~~~~~~~~~

.. autoapisummary::

   optimeed.core.tikzTranslator.templates_tikz


.. py:data:: templates_tikz

   

.. py:function:: format_escape_char(theStr)


.. py:function:: convert_linestyle(linestyle)


.. py:function:: find_all_colors(theGraphs)


.. py:function:: convert_marker(marker)


.. py:function:: do_preamble()


.. py:function:: do_generate_figure()


.. py:function:: do_specific_axis_options(theGraph: optimeed.core.graphs.Graph)

   Get graph-specific axis options


.. py:function:: do_specific_trace_options(theTrace: optimeed.core.graphs.Data, theColor)

   Get latex trace options from Data


.. py:function:: export_to_tikz_groupGraphs(theGraphs: optimeed.core.graphs.Graphs, foldername, additionalPreamble=lambda: '', additionalAxisOptions=lambda graphId: '', additionalTraceOptions=lambda graphId, traceId: '', debug=False)

   Export the graphs as group

   :param theGraphs: Graphs to save
   :param foldername: Foldername to save
   :param additionalPreamble: method that returns string for custom tikz options
   :param additionalAxisOptions: method that returns string for custom tikz options
   :param additionalTraceOptions: method that returns string for custom tikz options
   :return:


.. py:function:: do_preamble3D()


.. py:function:: format_Griddata(X, Y, Z)


.. py:function:: format_scatterdata(x, y, z)


.. py:function:: export_to_tikz_contour_plot(list_of_traces3, foldername, filename_data='data')

   Export the graphs as group

   :param list_of_traces3: List of 3D traces
   :param foldername: Foldername to save
   :param filename_data: filename of the data
   :return: