opticam.utils.logging
=====================

.. py:module:: opticam.utils.logging


Functions
---------

.. autoapisummary::

   opticam.utils.logging.log_binnings
   opticam.utils.logging.log_filters
   opticam.utils.logging.recursive_log
   opticam.utils.logging.log_psf_params


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

.. py:function:: log_binnings(file_paths, out_directory)

   Log the binning of each file to out_directory/diag/binnings.json.

   Parameters
   ----------
   file_paths : List[str]
       The paths to the files.
   out_directory : str
       The directory to save the log.


.. py:function:: log_filters(file_paths, out_directory)

   Logs the filters used in each file to out_directory/diag/filters.json.

   Parameters
   ----------
   file_paths : List[str]
       The paths to the files.
   out_directory : str
       The directory to save the log.


.. py:function:: recursive_log(param, depth = 0, max_depth = 5)

   Recursively log parameters.

   Parameters
   ----------
   param : Any
       The parameter to log.
   depth : int, optional
       The parameter depth, by default 0.
   max_depth : int, optional
       The maximum parameter depth, by default 5. This prevents infinite recursion.

   Returns
   -------
   Any
       The logged parameter.


.. py:function:: log_psf_params(out_directory, psf_params, binning_scale, rebin_factor)

   Log the PSF parameters.

   Parameters
   ----------
   out_directory : str
       The path to the output directory.
   psf_params : Dict[str, Dict[str, float]]
       The PSF parameters.
   binning_scale : int
       The observation binning scale.
   rebin_factor : int
       The software rebinning factor.