The kmo_fits_strip recipe
===============================================================

.. data:: kmo_fits_strip

Synopsis
--------

Strip noise, rotator and/or empty extensions from a processed KMOS fits frame

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

With this recipe KMOS fits frames can be stripped in following way:

--noise
All noise extensions will be removed. Only the data extensions remain.


--angle
Applies only to calibration products from kmo_flat and kmo_wave_cal.

All extensions matching provided angle are kept, the others are removed.

Supply a single integer value.


--empty
All empty extensions will be removed.


--extension
Supply a comma-separated string with integer values indicating the extensions
to keep. The other extensions are removed (any data or noise information is
disregarded, the values are interpreted absolutely)

The parameters --noise, --angle and --empty can be combined.

When --extension is specified, all other parameters are ignored.

When no parameter is provided, no output will be generated.


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

   DO                    KMOS                                                  
   category              Type   Explanation                    Required #Frames
   --------              -----  -----------                    -------- -------
   <none or any>         F2D or frame to strip                     Y       1   
                         F3I or
                         F2I or
                         F1I or

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

   DO                    KMOS
   category              Type   Explanation
   --------              -----  -----------
   STRIP                 F2D or Stripped frame
                         F3I or 
                         F2I or 
                         F1I    


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

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

   Create an object for the recipe kmo_fits_strip.

::

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

Parameters
----------

.. py:attribute:: kmo_fits_strip.param.empty

    TRUE: if empty extensions shall be removed, FALSE: otherwise (bool;  default: False) [default=False].
.. py:attribute:: kmo_fits_strip.param.noise

    TRUE: if noise extensions shall be removed, FALSE: otherwise (bool;  default: False) [default=False].
.. py:attribute:: kmo_fits_strip.param.angle

    All extensions not matching provided angle are stripped. (int;  default: -1) [default=-1].
.. py:attribute:: kmo_fits_strip.param.extension

    Comma-separated string with integers. All extensions matching these  values are stripped. (str; default: None) [default="None"].


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

::

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

   kmo_fits_strip.param.empty = False
   kmo_fits_strip.param.noise = False
   kmo_fits_strip.param.angle = -1
   kmo_fits_strip.param.extension = "None"


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

::

   import cpl
   kmo_fits_strip = cpl.Recipe("kmo_fits_strip")
   [...]
   res = kmo_fits_strip( ..., param = {"empty":False, "noise":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 `Alex Agudo Berbel <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 <usd-help@eso.org>