:py:mod:`rofunc.utils.visualab.utils`
=====================================

.. py:module:: rofunc.utils.visualab.utils

.. autodoc2-docstring:: rofunc.utils.visualab.utils
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`Frame <rofunc.utils.visualab.utils.Frame>`
     - .. autodoc2-docstring:: rofunc.utils.visualab.utils.Frame
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`set_axis <rofunc.utils.visualab.utils.set_axis>`
     - .. autodoc2-docstring:: rofunc.utils.visualab.utils.set_axis
          :summary:
   * - :py:obj:`save_img <rofunc.utils.visualab.utils.save_img>`
     - .. autodoc2-docstring:: rofunc.utils.visualab.utils.save_img
          :summary:
   * - :py:obj:`make_3d_axis <rofunc.utils.visualab.utils.make_3d_axis>`
     - .. autodoc2-docstring:: rofunc.utils.visualab.utils.make_3d_axis
          :summary:
   * - :py:obj:`plot_basis <rofunc.utils.visualab.utils.plot_basis>`
     - .. autodoc2-docstring:: rofunc.utils.visualab.utils.plot_basis
          :summary:

API
~~~

.. py:function:: set_axis(ax, data=None, labels=None, elev=45, azim=45, roll=0)
   :canonical: rofunc.utils.visualab.utils.set_axis

   .. autodoc2-docstring:: rofunc.utils.visualab.utils.set_axis

.. py:function:: save_img(fig, save_dir, fig_name=None, dpi=300, transparent=False, format=None)
   :canonical: rofunc.utils.visualab.utils.save_img

   .. autodoc2-docstring:: rofunc.utils.visualab.utils.save_img

.. py:class:: Frame(A2B, label=None, s=1.0, **kwargs)
   :canonical: rofunc.utils.visualab.utils.Frame

   Bases: :py:obj:`matplotlib.artist.Artist`

   .. autodoc2-docstring:: rofunc.utils.visualab.utils.Frame

   .. rubric:: Initialization

   .. autodoc2-docstring:: rofunc.utils.visualab.utils.Frame.__init__

   .. py:method:: set_data(A2B, label=None)
      :canonical: rofunc.utils.visualab.utils.Frame.set_data

      .. autodoc2-docstring:: rofunc.utils.visualab.utils.Frame.set_data

   .. py:method:: draw(renderer, *args, **kwargs)
      :canonical: rofunc.utils.visualab.utils.Frame.draw

      .. autodoc2-docstring:: rofunc.utils.visualab.utils.Frame.draw

   .. py:method:: add_frame(axis)
      :canonical: rofunc.utils.visualab.utils.Frame.add_frame

      .. autodoc2-docstring:: rofunc.utils.visualab.utils.Frame.add_frame

.. py:function:: make_3d_axis(ax_s, pos=111, unit=None, n_ticks=5)
   :canonical: rofunc.utils.visualab.utils.make_3d_axis

   .. autodoc2-docstring:: rofunc.utils.visualab.utils.make_3d_axis

.. py:function:: plot_basis(ax=None, R=None, p=np.zeros(3), s=1.0, ax_s=1, strict_check=True, **kwargs)
   :canonical: rofunc.utils.visualab.utils.plot_basis

   .. autodoc2-docstring:: rofunc.utils.visualab.utils.plot_basis