eye_patch.naming
================

.. py:module:: eye_patch.naming


Classes
-------

.. autoapisummary::

   eye_patch.naming.FITSMaskNames


Functions
---------

.. autoapisummary::

   eye_patch.naming.create_fits_mask_names


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

.. py:class:: FITSMaskNames

   Bases: :py:obj:`NamedTuple`


   Contains the names of the FITS images created when creating a mask image/
   These are only the names, and do not mean that they are necessarily created.


   .. py:attribute:: mask_fits
      :type:  pathlib.Path

      Name of the mask FITS file


   .. py:attribute:: scale_mask_fits
      :type:  pathlib.Path | None
      :value: None


      Path to a FITS file that describes per-scale clean masks. Scales are represented with a bit-mapped values,


   .. py:attribute:: signal_fits
      :type:  pathlib.Path | None
      :value: None


      Name of the signal FITS file


.. py:function:: create_fits_mask_names(fits_image: str | pathlib.Path, include_signal_path: bool = False) -> FITSMaskNames

   Create the names that will be used when generate FITS mask products

   :param fits_image: Base name of the output files
   :type fits_image: Union[str,]Path
   :param include_signal_path: If True, also include ``signal_fits`` in the output. Defaults to False.
   :type include_signal_path: bool, optional

   :returns: collection of names used for the signal and mask FITS images
   :rtype: FITSMaskNames