opticam.utils.helpers
=====================

.. py:module:: opticam.utils.helpers


Functions
---------

.. autoapisummary::

   opticam.utils.helpers.camel_to_snake
   opticam.utils.helpers.sort_filters
   opticam.utils.helpers.create_file_paths


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

.. py:function:: camel_to_snake(string)

   Convert a camelCase string to snake_case.

   Parameters
   ----------
   string : str
       The camelCase string to convert.

   Returns
   -------
   str
       The converted snake_case string.


.. py:function:: sort_filters(d)

   Sort a dictionary whose keys are filter names in the order of the camera filters (e.g., u/g, r, i/z).

   Parameters
   ----------
   d : Dict[str, Any]
       A dictionary with filter names as keys.

   Returns
   -------
   Dict[str, Any]
       The sorted dictionary.


.. py:function:: create_file_paths(data_directory = None, c1_directory = None, c2_directory = None, c3_directory = None)

   Given some directories, get the paths to all available FITS files.

   Parameters
   ----------
   data_directory : None | str, optional
       The directory containing the FITS files of all three cameras, by default None.
   c1_directory : None | str, optional
       The directory containing the FITS files of Camera 1, by default None.
   c2_directory : None | str, optional
       The directory containing the FITS files of Camera 2, by default None.
   c3_directory : None | str, optional
       The directory containing the FITS files of Camera 3, by default None.

   Returns
   -------
   List[str]
       The file paths.