jaxoplanet.starry.visualization
===============================

.. py:module:: jaxoplanet.starry.visualization


Functions
---------

.. autoapisummary::

   jaxoplanet.starry.visualization.show_surface


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

.. py:function:: show_surface(ylm_pijk_surface_body, theta: float = 0.0, res: int = 150, n: int = 6, ax=None, white_contour: bool = True, radius: float = None, include_phase: bool = True, rv=False, return_im=False, **kwargs)

   Show map of a

   :param ylm_pijk_surface_body: Ylm, Pijk, Surface or
                                 Body with a surface
   :type ylm_pijk_surface_body: Ylm, Pijk, Surface or SurfaceBody
   :param theta: Rotation angle of the map wrt its rotation axis.
                 Defaults to 0.0.
   :type theta: float, optional
   :param res: Resolution of the map render. Defaults to 400.
   :type res: int, optional
   :param n: number of latitude and longitude lines to show.
             Defaults to 6.
   :type n: int, optional
   :param ax: plot axes. Defaults to None.
   :type ax: matplotlib.pyplot.Axes, optional
   :param white_contour: Whether to surround the map by a white border
                         (to hide border pixel aliasing). Defaults to True.
   :type white_contour: bool, optional
   :param radius: Radius of the body. Defaults to None.
   :type radius: float, optional
   :param include_phase: Whether to add the proper phase to the map to
                         the rotation angle theta. Defaults to True.
   :type include_phase: bool, optional