kai.reduce.kai_util
===================

.. py:module:: kai.reduce.kai_util


Attributes
----------

.. autoapisummary::

   kai.reduce.kai_util._nargs


Functions
---------

.. autoapisummary::

   kai.reduce.kai_util.kailog
   kai.reduce.kai_util.makelog
   kai.reduce.kai_util.getAotsxy
   kai.reduce.kai_util.pix2radec
   kai.reduce.kai_util.radec2pix
   kai.reduce.kai_util.aotsxy2pix
   kai.reduce.kai_util.pcuxy2pix
   kai.reduce.kai_util.pix2xyarcsec
   kai.reduce.kai_util.xyarcsec2pix
   kai.reduce.kai_util.rotate_coo
   kai.reduce.kai_util.getScale
   kai.reduce.kai_util.getPA
   kai.reduce.kai_util.getCentralWavelength
   kai.reduce.kai_util.calcOverhead
   kai.reduce.kai_util.plotKeyword
   kai.reduce.kai_util.restackCoadd
   kai.reduce.kai_util.add_wcs_keywords


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

.. py:function:: kailog(directory)

.. py:function:: makelog(directory, outfile='image_log.txt', instrument=instruments.default_inst)

   
   Make an electronic log for all the FITS files in the 
   specified directory.
















   ..
       !! processed by numpydoc !!

.. py:data:: _nargs

.. py:function:: getAotsxy(hdr)

.. py:function:: pix2radec()

.. py:function:: radec2pix(radec, phi, scale, posRef)

   
   Determine pixel shifts from true RA and Dec positions.

   @param radec: a 2-element list containing the RA and Dec in degrees.
   @type radec: float list
   @param phi: position angle (E of N) in degrees.
   @type phi: float
   @param scale: arcsec per pixel.
   @type scale: float
   @param posRef: 2-element list containing the ra, dec positions (in degrees)
           of a reference object.
   @type posRef: float list















   ..
       !! processed by numpydoc !!

.. py:function:: aotsxy2pix(aotsxy, scale, aotsxyRef, inst_angle=0.0)

.. py:function:: pcuxy2pix(pcuxy, phi, scale, pcuxyRef)

   
   Determine pixel shifts from true RA and Dec positions.

   @param pcuxy: a 2-element list containing the PCU x and y in mm.
   @type pcuxy: float list
   @param phi: position angle (E of N) in degrees.
   @type phi: float
   @param scale: mm per pixel.
   @type scale: float
   @param pcuxyRef: 2-element list containing the  PCU x, y positions (in mm) in the reference position.
   @type pcuxyRef: float list















   ..
       !! processed by numpydoc !!

.. py:function:: pix2xyarcsec(xypix, phi, scale, sgra)

   
   Determine  E and N offsets from Sgr A* (in arcsec) from 
   pixel positions and the pixel position of Sgr A*.

   xypix: 2-element list containing the RA and Dec in degrees.
   phi: position angle (E of N) in degrees.
   scale: arcsec per pixel.
   sgra: 2-element list containing the pixel position of Sgr A*.















   ..
       !! processed by numpydoc !!

.. py:function:: xyarcsec2pix(xyarcsec, phi, scale)

   
   Determine pixel shifts from E and N offsets from Sgr A*.

   xyarcsec: 2-element list containing the RA and Dec in degrees.
   phi: position angle (E of N) in degrees.
   scale: arcsec per pixel.















   ..
       !! processed by numpydoc !!

.. py:function:: rotate_coo(x, y, phi)

   
   Rotate the coordinates in the *.coo files for data sets
   containing images at different PAs.
















   ..
       !! processed by numpydoc !!

.. py:function:: getScale(hdr, instrument=instruments.default_inst)

.. py:function:: getPA(hdr, instrument=instruments.default_inst)

.. py:function:: getCentralWavelength(hdr, instrument=instruments.default_inst)

.. py:function:: calcOverhead(tint, coadds, ndithers, nframes, reads, tread=0.181)

.. py:function:: plotKeyword(keyword1, keyword2, imgList)

   
   Pass in a file containing a list of images. For each of these
   images, read out the values of the header keywords specified.
   Then plot each of the keywords against each other.
















   ..
       !! processed by numpydoc !!

.. py:function:: restackCoadd(clean_directory, raw_directory, raw_unp_directory, save_diagnostics=False, save_coadds=False)

   
   Process unprocessed FITS frames and coadds to align star positions, stack them,
   and optionally save diagnostics and intermediate outputs. This stacks to the first coadd.

   @param clean_directory: Path to directory containing .coo files with reference star positions.
   @type clean_directory: str
   @param raw_directory: Path to directory containing raw FITS frames.
   @type raw_directory: str
   @param raw_unp_directory: Path to directory containing unprocessed FITS files (n_unp_###.fits).
   @type raw_unp_directory: str
   @param save_diagnostics: If True, saves intermediate plots and motion diagnostics.
   @type save_diagnostics: bool
   @param save_coadds: If True, saves individual coadd FITS frames.
   @type save_coadds: bool















   ..
       !! processed by numpydoc !!

.. py:function:: add_wcs_keywords(header, instrument)

   
   Adds WCS keywords to file. 
   If WCS exists, this overwrites it.


   :Parameters:

       **header: fits header**
           Fits header of file to be updated

       **instrument: instrument object**
           Instrument obejct from kai.instruments














   ..
       !! processed by numpydoc !!