opticam.plotting.plots
======================

.. py:module:: opticam.plotting.plots


Functions
---------

.. autoapisummary::

   opticam.plotting.plots.plot_catalogs
   opticam.plotting.plots.plot_time_between_files
   opticam.plotting.plots.plot_backgrounds
   opticam.plotting.plots.plot_background_meshes
   opticam.plotting.plots.plot_growth_curves


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

.. py:function:: plot_catalogs(out_directory, stacked_images, catalogs, show, save)

   Plot the source catalogs.

   Parameters
   ----------
   out_directory : str
       The directory path to which the resulting plot will be saved.
   filters : List[str]
       The catalog filters.
   stacked_images : Dict[str, NDArray]
       The stacked images for each filter {filter: image}.
   show : bool
       Whether to show the plot.
   save : bool
       Whether to save the plot.


.. py:function:: plot_time_between_files(out_directory, camera_files, bmjds, show, save)

   Plot the times between files. Useful for identifying gaps.

   Parameters
   ----------
   out_directory : str
       The directory path to which the resulting plot will be saved.
   camera_files : Dict[str, List[str]]
       The file paths separated by camera {filter: file paths}.
   bmjds : Dict[str, float]
       The file time stamps {file path: time stamp}.
   show : bool
       Whether to show the plot.
   save : bool
       Whether to save the plot.


.. py:function:: plot_backgrounds(out_directory, camera_files, background_median, background_rms, bmjds, t_ref, show, save)

   Plot the time-varying background for each camera.

   Parameters
   ----------
   camera_files : Dict[str, str]
       The files for each camera {fltr: file}.
   background_median : Dict[str, List]
       The median background for each camera.
   background_rms : Dict[str, List]
       The background RMS for each camera.
   bmjds : Dict[str, float]
       The Barycentric MJD dates for each image {file: BMJD}.
   t_ref : float
       The reference BMJD.
   out_directory : str
       The directory to which the resulting files will be saved.
   show: bool
       Whether to display the plot.
   save : bool
       Whether to save the plot.


.. py:function:: plot_background_meshes(out_directory, filters, stacked_images, background, show, save)

   Plot the background meshes on top of the catalog images.

   Parameters
   ----------
   stacked_images : Dict[str, NDArray]
       The stacked images for each camera.
   show : bool
       Whether to display the plot.


.. py:function:: plot_growth_curves(image, cat, targets, psf_params)

   Plot the growth curves given a (stacked) image and a source catalog.

   Parameters
   ----------
   image : NDArray
       The image.
   cat : QTable
       The catalog corresponding to `image`.
   targets : int | List[int]
       The target(s) for which growth curves are to be computed.
   psf_params : Dict
       The PSF parameters.

   Returns
   -------
   Figure
       The growth curve plots.