opticam.plotting.gifs
=====================

.. py:module:: opticam.plotting.gifs


Functions
---------

.. autoapisummary::

   opticam.plotting.gifs.create_gif_frame
   opticam.plotting.gifs.compile_gif


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

.. py:function:: create_gif_frame(file, out_directory, aperture_selector, catalog, key, instrument, transforms, reference_file, rebin_factor, background)

   Create an alignment GIF frame.

   Parameters
   ----------
   file : MEFSlice
       The `MEFSlice` instance representing the image.
   out_directory : Path
       The output directory.
   aperture_selector : Callable
       The aperture selector function.
   catalog : QTable
       The catalogue.
   key : str
       The camera:filter key.
   instrument : Instrument
       The instrument that produced the image.
   transforms : Dict[str, List[float]]
       The alignment transformations.
   reference_file : MEFSlice
       The `MEFSlice` instance representing the reference file.
   rebin_factor : int
       The image rebin factor.
   background : BaseBackground
       The background estimator.


.. py:function:: compile_gif(out_directory, key, camera_files, keep_frames)

   Create a GIF file from the frames saved in `out_directory`.

   Parameters
   ----------
   out_directory : Path
       The output directory.
   key : str
       The camera:filter key.
   camera_files : Dict[str, List[MEFSlice]]
       The image files grouped by filter.
   keep_frames : bool
       Whether to keep the frames after the GIT file is saved.