The vmspphot recipe
===============================================================

.. data:: vmspphot

Synopsis
--------

Apply to IFU or MOS 1D-extracted spectra a flux correction.

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

This recipe can be used to apply a spectro-photometric flux calibration
to any number of 1D-extracted spectral frames generated by the recipes
vmmosobsstare, vmmosobsjitter, and vmifuscience.


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

  DO category:                Type:       Explanation:            Required:
  MOS_SCIENCE_REDUCED 
  or IFU_SCIENCE_REDUCED      Product     Extracted MOS or IFU spectra Y
  EXTINCT_TABLE               Calib       Atmospheric extinction       Y
  MOS_SPECPHOT_TABLE
  or IFU_SPECPHOT_TABLE       Calib       Response curve               .


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

  DO category:                Data type:  Explanation:
  MOS_SCIENCE_FLUX_REDUCED
  or IFU_SCIENCE_FLUX_REDUCED FITS image  Flux calibrated objects spectra

For more details, please refer to the VIMOS Pipeline User's Guide.


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

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

   Create an object for the recipe vmspphot.

::

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

Parameters
----------

.. py:attribute:: vmspphot.param.ApplyResponse

    Apply instrument response. (bool; default: True) [default=True].


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

::

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

   vmspphot.param.ApplyResponse = True


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

::

   import cpl
   vmspphot = cpl.Recipe("vmspphot")
   [...]
   res = vmspphot( ..., param = {"ApplyResponse":True})


.. 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 VIMOS Pipeline Team <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 VIMOS Instrument Pipeline
Copyright (C) 2002-2005 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:: ESO VIMOS Pipeline Team <https://support.eso.org>