The muse_scipost_subtract_sky recipe
===============================================================

.. data:: muse_scipost_subtract_sky

Synopsis
--------

Subtract night sky model.

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

Subtract the sky as defined by the sky lines and continuum from a pixel table. This is a separated task of muse_scipost.


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

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

   Create an object for the recipe muse_scipost_subtract_sky.

::

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

Parameters
----------

.. py:attribute:: muse_scipost_subtract_sky.param.lambdamin

    Cut off the data below this wavelength after loading the pixel  table(s). (float; default: 4000.0) [default=4000.0].
.. py:attribute:: muse_scipost_subtract_sky.param.lambdamax

    Cut off the data above this wavelength after loading the pixel  table(s). (float; default: 10000.0) [default=10000.0].
.. py:attribute:: muse_scipost_subtract_sky.param.orig

    If specified, write an additional column containing the original data  to the pixel table. (str; default: '') [default=""].
.. py:attribute:: muse_scipost_subtract_sky.param.flux_sky

    Reference flat field flux, obtained by sky exposure. This parameter is  needed to scale the data of each pixel table if more than one pixel  table was used to determine the sky. By default, it is taken from the  parameter ESO DRS MUSE FLAT FLUX SKY of the first pixel table. (float;  default: 0.0) [default=0.0].
.. py:attribute:: muse_scipost_subtract_sky.param.flux_lamp

    Reference flat field flux, obtained by lamp exposure. This parameter  is needed to scale the data of each pixel table if more than one pixel  table was used to determine the sky. By default, it is taken from the  parameter ESO DRS MUSE FLAT FLUX LAMP of the first pixel table.  (float; default: 0.0) [default=0.0].


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

::

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

   muse_scipost_subtract_sky.param.lambdamin = 4000.0
   muse_scipost_subtract_sky.param.lambdamax = 10000.0
   muse_scipost_subtract_sky.param.orig = ""
   muse_scipost_subtract_sky.param.flux_sky = 0.0
   muse_scipost_subtract_sky.param.flux_lamp = 0.0


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

::

   import cpl
   muse_scipost_subtract_sky = cpl.Recipe("muse_scipost_subtract_sky")
   [...]
   res = muse_scipost_subtract_sky( ..., param = {"lambdamin":4000.0, "lambdamax":10000.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 `Ole Streicher <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 MUSE Instrument Pipeline
Copyright (C) 2005, 2018 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., 51 Franklin St, Fifth Floor, Boston, 
MA  02111-1307  USA

.. codeauthor:: Ole Streicher <usd-help@eso.org>
