opticam.mef_slice
=================

.. py:module:: opticam.mef_slice


Classes
-------

.. autoapisummary::

   opticam.mef_slice.MEFSlice


Functions
---------

.. autoapisummary::

   opticam.mef_slice.create_file_paths


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

.. py:class:: MEFSlice

   Helper class to represent a slice of a Multi-extension FITS (MEF) file.

   Parameters
   ----------
   path : Path
       The file path.
   ext : int
       The slice's extension number.


   .. py:attribute:: path
      :type:  pathlib.Path


   .. py:attribute:: ext
      :type:  int


   .. py:property:: key
      :type: str


      The file path and extension number combined to create a uniquely identifiable string.

      Returns
      -------
      str
          The uniquely identifiable string.



   .. py:method:: get_header()

      Get the slice's header.

      Returns
      -------
      Header
          The slice's header.



   .. py:method:: get_data()

      Get the slice's data.

      Returns
      -------
      NDArray[np.float64]
          The slice's data.



   .. py:method:: get_data_and_header()

      Get the slice's data and header.

      Returns
      -------
      tuple[NDArray[np.float64], Header]
          The slice's data and header.



.. py:function:: create_file_paths(data_directory)

   Given a directory, return all the (multi-extension) FITS file paths and extension numbers.

   Parameters
   ----------
   data_directory : Path
       The directory containing one or more (multi-extension) FITS files.

   Returns
   -------
   list[MEFSlice]
       The list of (multi-extension) FITS slices.