The fors_img_science recipe
===============================================================

.. data:: fors_img_science

Synopsis
--------

Reduce scientific exposure

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

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

  DO category:               Type:       Explanation:             Number:
  SCIENCE_IMG                Raw         Science image               1
  MASTER_BIAS                FITS image  Master bias                 1
  MASTER_SKY_FLAT_IMG        FITS image  Master sky flat field       1

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

  DO category:               Data type:  Explanation:
  SCIENCE_REDUCED_IMG        FITS image  Reduced science image
  PHOT_BACKGROUND_SCI_IMG    FITS image  Reduced science image background
  SOURCES_SCI_IMG            FITS image  Unfiltered SExtractor output
  OBJECT_TABLE_SCI_IMG       FITS table  Extracted sources properties

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

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

   Create an object for the recipe fors_img_science.

::

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

Parameters
----------

.. py:attribute:: fors_img_science.param.magsyserr

    Systematic error in magnitude (float; default: 0.01) [default=0.01].
.. py:attribute:: fors_img_science.param.sex_exe

    SExtractor executable (str; default: '/usr/bin/sex') [default="/usr/bin/sex"].
.. py:attribute:: fors_img_science.param.sex_config

    SExtractor configuration file (str; default: '/usr/share/cpl-  plugins/fors-5.1.4/config/fors.sex') [default="/usr/share/cpl-plugins/fors-5.1.4/config/fors.sex"].
.. py:attribute:: fors_img_science.param.sex_mag

    SExtractor magnitude (str; default: 'MAG_APER') [default="MAG_APER"].
.. py:attribute:: fors_img_science.param.sex_magerr

    SExtractor magnitude error (str; default: 'MAGERR_APER') [default="MAGERR_APER"].
.. py:attribute:: fors_img_science.param.sex_radius

    Background error map median filter radius (unbinned pixels) (long;  default: 64) [default=64].


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

::

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

   fors_img_science.param.magsyserr = 0.01
   fors_img_science.param.sex_exe = "/usr/bin/sex"
   fors_img_science.param.sex_config = "/usr/share/cpl-plugins/fors-5.1.4/config/fors.sex"
   fors_img_science.param.sex_mag = "MAG_APER"
   fors_img_science.param.sex_magerr = "MAGERR_APER"
   fors_img_science.param.sex_radius = 64


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

::

   import cpl
   fors_img_science = cpl.Recipe("fors_img_science")
   [...]
   res = fors_img_science( ..., param = {"magsyserr":0.01, "sex_exe":"/usr/bin/sex"})


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

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

Please report any problems to `Jonas M. Larsen <usd-help@eso.org>`_. Alternatively, you may 
send a report to the `ESO User Support Department <usd-help@eso.org>`_.

Copyright
---------

This file is currently part of the FORS 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 St, Fifth Floor, Boston, MA  02110-1301  USA


.. codeauthor:: Jonas M. Larsen <usd-help@eso.org>
