pencil.visu.internal
====================

.. py:module:: pencil.visu.internal


Submodules
----------

.. toctree::
   :maxdepth: 1

   /code/sourcePython/pencil/visu/internal/MinorSymLogLocator/index
   /code/sourcePython/pencil/visu/internal/calc_lims/index
   /code/sourcePython/pencil/visu/internal/export_fig/index
   /code/sourcePython/pencil/visu/internal/prepare_fig/index


Classes
-------

.. autoapisummary::

   pencil.visu.internal.MinorSymLogLocator


Functions
---------

.. autoapisummary::

   pencil.visu.internal.calc_lims
   pencil.visu.internal.export_fig
   pencil.visu.internal.preparePlot


Package Contents
----------------

.. py:function:: calc_lims(val_min=False, val_max=False, offset=False)

   Gives back an optimal limit for an plot upper or lower value. Therefor, it uses an inbuild offset from the PROFILE.


.. py:function:: export_fig(fig, filepath, filename=False, PNG=True, PDF=False, EPS=False, DPI=300, EXPORT_BBOX_INCES='tight', transparent=True, verbose=True, timestamp=False)

   Does a proper export of a figure handle to all kind of image files.


.. py:class:: MinorSymLogLocator(linthresh)

   Bases: :py:obj:`matplotlib.ticker.Locator`


   Dynamically find minor tick positions based on the positions of
   major ticks for a symlog scaling.

   Ticks will be placed between the major ticks.
   The placement is linear for x between -linthresh and linthresh,
   otherwise its logarithmically


   .. py:attribute:: linthresh


.. py:function:: preparePlot(x_datasets, y_datasets, x_errors=False, y_errors=False, xmin=False, xmax=False, ymin=False, ymax=False, xlog=False, ylog=False, fig=False, ax=False, PROFILE=False)