The kmos_dark recipe
===============================================================

.. data:: kmos_dark

Synopsis
--------

Create master dark frame & bad pixel mask

Description
-----------

This recipe calculates the master dark frame.


It is recommended to provide three or more dark exposures to produce a
reasonable master with associated noise.


Input files
^^^^^^^^^^^^
::

   DO CATG          Type   Explanation                     Required #Frames
   -------          -----  -----------                     -------- -------
   DARK             RAW    Dark exposures                     Y       1-n  
                           (at least 3 frames recommended)                 

Output files
^^^^^^^^^^^^
::

   DO CATG          Type   Explanation
   -------          -----  -----------
   MASTER_DARK      F2D    Calculated master dark frames
   BADPIXEL_DARK    B2D    Associated badpixel frames

Constructor
-----------

.. method:: cpl.Recipe("kmos_dark")
   :noindex:

   Create an object for the recipe kmos_dark.

::

   import cpl
   kmos_dark = cpl.Recipe("kmos_dark")

Parameters
----------

.. py:attribute:: kmos_dark.param.oscan

    Apply Overscan Correction (bool; default: True) [default=True].
.. py:attribute:: kmos_dark.param.pos_bad_pix_rej

    The positive rejection threshold for bad pixels (float; default: 50.0) [default=50.0].
.. py:attribute:: kmos_dark.param.neg_bad_pix_rej

    The negative rejection threshold for bad pixels (float; default: 50.0) [default=50.0].
.. py:attribute:: kmos_dark.param.file_extension

    Controls if EXPTIME should be appended to product filenames (bool;  default: False) [default=False].
.. py:attribute:: kmos_dark.param.cmethod

    Apply "average", "median", "sum", "min_max." or "ksigma". (str;  default: 'ksigma') [default="ksigma"].
.. py:attribute:: kmos_dark.param.cpos_rej

    The positive rejection threshold for kappa-sigma-clipping (sigma).  (float; default: 3.0) [default=3.0].
.. py:attribute:: kmos_dark.param.cneg_rej

    The negative rejection threshold for kappa-sigma-clipping (sigma).  (float; default: 3.0) [default=3.0].
.. py:attribute:: kmos_dark.param.citer

    The number of iterations for kappa-sigma-clipping. (int; default: 3) [default=3].
.. py:attribute:: kmos_dark.param.cmax

    The number of maximum pixel values to clip with min/max-clipping.  (int; default: 1) [default=1].
.. py:attribute:: kmos_dark.param.cmin

    The number of minimum pixel values to clip with min/max-clipping.  (int; default: 1) [default=1].


The following code snippet shows the default settings for the available 
parameters.

::

   import cpl
   kmos_dark = cpl.Recipe("kmos_dark")

   kmos_dark.param.oscan = True
   kmos_dark.param.pos_bad_pix_rej = 50.0
   kmos_dark.param.neg_bad_pix_rej = 50.0
   kmos_dark.param.file_extension = False
   kmos_dark.param.cmethod = "ksigma"
   kmos_dark.param.cpos_rej = 3.0
   kmos_dark.param.cneg_rej = 3.0
   kmos_dark.param.citer = 3
   kmos_dark.param.cmax = 1
   kmos_dark.param.cmin = 1


You may also set or overwrite some or all parameters by the recipe 
parameter `param`, as shown in the following example:

::

   import cpl
   kmos_dark = cpl.Recipe("kmos_dark")
   [...]
   res = kmos_dark( ..., param = {"oscan":True, "pos_bad_pix_rej":50.0})


.. seealso:: `cpl.Recipe <https://packages.python.org/python-cpl/recipe.html>`_
   for more information about the recipe object.

Bug reports
-----------

Please report any problems to `Alex Agudo Berbel, Yves Jung <usd-help@eso.org>`_. Alternatively, you may 
send a report to the `ESO User Support Department <usd-help@eso.org>`_.

Copyright
---------

This file is part of the CRIRES Instrument Pipeline
Copyright (C) 2002,2003 European Southern Observatory

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, 
MA  02111-1307  USA

.. codeauthor:: Alex Agudo Berbel, Yves Jung <usd-help@eso.org>