The fors_extract_objects recipe
===============================================================

.. data:: fors_extract_objects

Synopsis
--------

Extract objects in slit spectra

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

This recipe is used to extract scientific objects spectra on a resampled
image produced with recipe fors_resample, at the positions listed in the
object table produced by recipe fors_detect_objects. Please refer to the
FORS Pipeline User's Manual for more details on object extraction.


In the table below the MXU acronym can be alternatively read as MOS and
LSS, and SCI as STD.


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

  DO category:               Type:       Explanation:         Required:
  MAPPED_SCI_MXU             Calib       Resampled slit spectra  Y
  MAPPED_SKY_SCI_MXU         Calib       Resampled sky spectra   Y
  OBJECT_TABLE_SCI_MXU       Calib       Object table            Y

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

  DO category:               Data type:  Explanation:
  REDUCED_SCI_MXU            FITS image  Extracted object spectra
  REDUCED_SKY_SCI_MXU        FITS image  Extracted sky spectra
  REDUCED_ERROR_SCI_MXU      FITS image  Error on extracted spectra


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

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

   Create an object for the recipe fors_extract_objects.

::

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

Parameters
----------

.. py:attribute:: fors_extract_objects.param.ext_mode

    Object extraction method: 0 = aperture, 1 = Horne optimal extraction  (int; default: 1) [default=1].


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

::

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

   fors_extract_objects.param.ext_mode = 1


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

::

   import cpl
   fors_extract_objects = cpl.Recipe("fors_extract_objects")
   [...]
   res = fors_extract_objects( ..., param = {"ext_mode":1})


.. 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 `Carlo Izzo <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-2010 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:: Carlo Izzo <usd-help@eso.org>