===============
Reference Guide
===============
:Release: |version|

:Date: |today|

.. warning::

   This "Reference" is still a work in progress; some of the material
   is not organized, and several aspects of PAPI are not yet covered
   sufficient detail.
   
This will contain a reference guide for developers of the application.


:mod:`reduce.calDark` --- Dark combination
==========================================

.. automodule:: reduce.calDark
   :synopsis: Dark combination
   :members:
   :undoc-members:
   
:mod:`reduce.calDakModel` --- Dark model combination
====================================================

.. automodule:: reduce.calDarkModel
   :synopsis: Dark series combination for a dark model
   :members:
   :undoc-members:

:mod:`reduce.calDomeFlat` --- Dome Flat combination
===================================================

.. automodule:: reduce.calDomeFlat
   :synopsis: Dome Flat series combination for a master flat
   :members:
   :undoc-members:
   
:mod:`reduce.calTwFlat` --- Twlight Flat combination
====================================================

.. automodule:: reduce.calTwFlat
   :synopsis: Dome Twlight series combination for a master flat
   :members:
   :undoc-members:

:mod:`reduce.calBPM` --- Bad Pixel Map generation
=================================================

.. automodule:: reduce.calBPM
   :synopsis: Bad Pixel Map generation from a master dark a master flat
   :members:
   :undoc-members:

:mod:`reduce.calGainMap` --- Gain Map generation
================================================

.. automodule:: reduce.calGainMap
   :synopsis: Gain Map generation from a master flat
   :members:
   :undoc-members:

:mod:`reduce.calCombineFF` --- Dome and sky master flats combination
====================================================================

.. automodule:: reduce.calCombineFF
   :synopsis: Dome and sky master flats combination
   :members:
   :undoc-members:

:mod:`reduce.calSuperFlat` --- Super master flats generation
============================================================

.. automodule:: reduce.calSuperFlat
   :synopsis: Super master flat generation
   :members:
   :undoc-members:
   
:mod:`reduce.applyDarkFlat` --- Dark and Flat correction
========================================================

.. automodule:: reduce.applyDarkFlat
   :synopsis: Dark and Flat Field correction
   :members:
   :undoc-members:

:mod:`reduce.NonLinearity` --- Non-Linearity correction
=======================================================

.. automodule:: reduce.calNonLinearity
   :synopsis: Non-Linearity correction
   :members:
   :undoc-members:      

:mod:`reduce.dxtak` --- Cross-talk correction
=============================================

.. automodule:: reduce.dxtalk
   :synopsis: Cross-talk correction
   :members:
   :undoc-members:   

:mod:`astromatic.swarp` --- SWARP wrapper
=========================================

.. automodule:: astromatic.swarp
   :synopsis: Image warping
   :members:
   :undoc-members:

   
:mod:`astromatic.scamp` --- SCAMP wrapper
=========================================

.. automodule:: astromatic.scamp
    :synopsis: Image astrometry
    :members:
    :undoc-members: