yieldplotlib.plots.yip_plots
============================

.. py:module:: yieldplotlib.plots.yip_plots

.. autoapi-nested-parse::

   Generate plots for yield input packages.



Functions
---------

.. autoapisummary::

   yieldplotlib.plots.yip_plots.make_offax_psf_movie
   yieldplotlib.plots.yip_plots.plot_core_throughtput


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

.. py:function:: make_offax_psf_movie(yip, save_name, ax_kwargs=None, plot_kwargs=None)

   Generate a movie of the off-axis stellar PSF moving as a function of lambda/D.

   Args:
       yip (YIPDirectory):
           YIPDirectory to plot.
       save_name (str):
           File path to where the output movie will be saved.
       ax_kwargs (dict, optional):
           Keyword arguments to pass to ax.set().
       plot_kwargs (dict, optional):
           Keyword arguments to pass to plt.figure().

   Returns:
       None


.. py:function:: plot_core_throughtput(runs, run_labels, yip=None, ax=None, ax_kwargs=None, use_cyberpunk=False, title=None, aperture_radius=0.85)

   Plot the core throughput as a function of lambda/D.

   Args:
       runs (list):
           List of EXOSIMSDirectories and AYODirectories to plot.
       run_labels (list):
           List of labels for each run.
       yip (YIPDirectory):
           YIPDirectory to plot. If None, the throughput directly from the YIP
           (accessed via yippy) will not be plotted.
       ax (matplotlib.axes.Axes, optional):
           Axes to plot on. If None, a new figure is created.
       ax_kwargs (dict, optional):
           Keyword arguments to pass to ax.set().
       use_cyberpunk (bool, optional):
           Whether to use the mplcyberpunk style. Default is False.
       title (str, optional):
            Title for the plot.
       aperture_radius (float):
           Radius of the photometric aperture to use for the YIP throughput
           calculation.

   Returns:
       matplotlib.figure.Figure, matplotlib.axes.Axes:
           Figure and axes objects for the plot.