kai.reduce.sky
==============

.. py:module:: kai.reduce.sky


Functions
---------

.. autoapisummary::

   kai.reduce.sky.makesky
   kai.reduce.sky.makesky_lp
   kai.reduce.sky.makesky_lp2
   kai.reduce.sky.makesky_fromsci
   kai.reduce.sky.makesky_lp_fromsci
   kai.reduce.sky.read_sky_rot_file
   kai.reduce.sky.write_sky_rot_file


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

.. py:function:: makesky(files, nite, wave, dark_frame=None, skyscale=True, raw_dir=None, instrument=instruments.default_inst)

   
   Make short wavelength (not L-band or longer) skies.


   :Parameters:

       **files** : list of int
           Integer list of the files. Does not require padded zeros.

       **nite** : str
           Name for night of observation (e.g.: "nite1"), used as suffix
           inside the reduce sub-directories.

       **wave** : str
           Name for the observation passband (e.g.: "kp")

       **dark_frame** : str, default=None
           File name for the dark frame in order to carry out dark correction.
           If not provided, dark frame is not subtracted and a warning is thrown.
           Assumes dark file is located under ./calib/darks/

       **skyscale** : bool, default=True
           Whether or not to scale the sky files to the common median.
           Turn on for scaling skies before subtraction.

       **raw_dir** : str, optional
           Directory where raw files are stored. By default,
           assumes that raw files are stored in '../raw'

       **instrument** : instruments object, optional
           Instrument of data. Default is `instruments.default_inst`














   ..
       !! processed by numpydoc !!

.. py:function:: makesky_lp(files, nite, wave, dark_frame=None, number=3, rejectHsigma=None, raw_dir=None, instrument=instruments.default_inst)

   
   Make L' skies by carefully treating the ROTPPOSN angle
   of the K-mirror. Uses 3 skies combined (set by number keyword).


   :Parameters:

       **files** : list of int
           Integer list of the files. Does not require padded zeros.

       **nite** : str
           Name for night of observation (e.g.: "nite1"), used as suffix
           inside the reduce sub-directories.

       **wave** : str
           Name for the observation passband (e.g.: "lp")

       **dark_frame** : str, default=None
           File name for the dark frame in order to carry out dark correction.
           If not provided, dark frame is not subtracted and a warning is thrown.
           Assumes dark file is located under ./calib/darks/

       **number** : int, default=3
           Number of skies to be combined

       **rejectHsigma** : int, default:None
           Flag to pass for rejectHsigma for IRAF imcombine
           By default, no flags are passed

       **raw_dir** : str, optional
           Directory where raw files are stored. By default,
           assumes that raw files are stored in '../raw'

       **instrument** : instruments object, optional
           Instrument of data. Default is `instruments.default_inst`














   ..
       !! processed by numpydoc !!

.. py:function:: makesky_lp2(files, nite, wave)

   
   Make L' skies by carefully treating the ROTPPOSN angle
   of the K-mirror. Uses only 2 skies combined.
















   ..
       !! processed by numpydoc !!

.. py:function:: makesky_fromsci(files, nite, wave, instrument=instruments.default_inst)

   
   Make short wavelength (not L-band or longer) skies.
















   ..
       !! processed by numpydoc !!

.. py:function:: makesky_lp_fromsci(files, nite, wave, number=3, rejectHsigma=None)

   
   Make L' skies by carefully treating the ROTPPOSN angle
   of the K-mirror. Uses 3 skies combined (set by number keyword).
















   ..
       !! processed by numpydoc !!

.. py:function:: read_sky_rot_file(sky_rot_file)

   
   Read in the list of files and rotation angles.
















   ..
       !! processed by numpydoc !!

.. py:function:: write_sky_rot_file(rawlis, nlis, skyRot)

   
   Write the list of files and rotation angles in Lp.
   Created to avoid using pyraf which causes issues when dealing
   with non-fits conforming headers.
















   ..
       !! processed by numpydoc !!