jaxoplanet.starry.visualization

jaxoplanet.starry.visualization#

Functions#

show_surface(ylm_pijk_surface_body[, theta, res, n, ...])

Show map of a

Module Contents#

jaxoplanet.starry.visualization.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)[source]#

Show map of a

Parameters:

  • ylm_pijk_surface_body (Ylm, Pijk, Surface or SurfaceBody) – Ylm, Pijk, Surface or Body with a surface

  • theta (float, optional) – Rotation angle of the map wrt its rotation axis. Defaults to 0.0.

  • res (int, optional) – Resolution of the map render. Defaults to 400.

  • n (int, optional) – number of latitude and longitude lines to show. Defaults to 6.

  • ax (matplotlib.pyplot.Axes, optional) – plot axes. Defaults to None.

  • white_contour (bool, optional) – Whether to surround the map by a white border (to hide border pixel aliasing). Defaults to True.

  • radius (float, optional) – Radius of the body. Defaults to None.

  • include_phase (bool, optional) – Whether to add the proper phase to the map to the rotation angle theta. Defaults to True.

Contents