The hawki_step_subtract_bkg recipe
===============================================================

.. data:: hawki_step_subtract_bkg

Synopsis
--------

(OBSOLETE) Background subtraction utility

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

(OBSOLETE) hawki_step_subtract_bkg -- hawki background subtraction utility.

This recipe will subtract the given background to the science images.

The background can be obtained from the sky or object images
using the hawki_util_compute_bkg utility.

There are two modes of operation:
One single background image that it is subtracted to all object images.

As many background images as objects. A one to one relationship is applied.

The files listed in the Set Of Frames (sof-file) must be tagged:
obj_basic_cal-file.fits BASIC_CALIBRATED or
background-file.fits BKG_IM 

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

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

   Create an object for the recipe hawki_step_subtract_bkg.

::

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



.. 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 `ESO Pipeline Group <https://support.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 HAWKI Instrument Pipeline
Copyright (C) 2002,2011 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 Street, Fifth Floor, Boston, 
MA 02110-1301 USA

.. codeauthor:: ESO Pipeline Group <https://support.eso.org>
