The kmos_sky_tweak recipe
===============================================================

.. data:: kmos_sky_tweak

Synopsis
--------

Removal of OH sky lines

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

 This recipes is an advanced tool to remove OH sky lines.


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

   DO CATG           Type   Explanation                    Required #Frames
   --------          -----  -----------                    -------- -------
   CUBE_OBJECT       F3I    object cubes                       Y      >=1  
   CUBE_SKY          F3I    sky cube                           Y       1   

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

   DO_CATG           Type   Explanation
   --------          -----  -----------
   OBJECT_S          F3I    Corrected object cubes


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

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

   Create an object for the recipe kmos_sky_tweak.

::

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

Parameters
----------

.. py:attribute:: kmos_sky_tweak.param.ifu

    Only reduce the specified IFU (int; default: 0) [default=0].
.. py:attribute:: kmos_sky_tweak.param.discard_subband

    Ignore last sub-band in the sky tweaking (bool; default: False) [default=False].
.. py:attribute:: kmos_sky_tweak.param.stretch

    Stretch sky (bool; default: False) [default=False].
.. py:attribute:: kmos_sky_tweak.param.stretch_degree

    Stretch polynomial degree (int; default: 8) [default=8].
.. py:attribute:: kmos_sky_tweak.param.stretch_resampling

    Stretch resampling method (linear/spline) (str; default: 'spline') [default="spline"].
.. py:attribute:: kmos_sky_tweak.param.plot

    Enable plotting (int; default: 0) [default=0].
.. py:attribute:: kmos_sky_tweak.param.tbsub

    Subtract thermal background from input cube (bool; default: True) [default=True].


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

::

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

   kmos_sky_tweak.param.ifu = 0
   kmos_sky_tweak.param.discard_subband = False
   kmos_sky_tweak.param.stretch = False
   kmos_sky_tweak.param.stretch_degree = 8
   kmos_sky_tweak.param.stretch_resampling = "spline"
   kmos_sky_tweak.param.plot = 0
   kmos_sky_tweak.param.tbsub = True


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

::

   import cpl
   kmos_sky_tweak = cpl.Recipe("kmos_sky_tweak")
   [...]
   res = kmos_sky_tweak( ..., param = {"ifu":0, "discard_subband":False})


.. 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 `Erich Wiezorrek, 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:: Erich Wiezorrek, Yves Jung <usd-help@eso.org>