The vmimcalphot recipe
===============================================================

.. data:: vmimcalphot

Synopsis
--------

Determine photometric calibration from a set of observed standard stars.

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

This recipe is used to determine night zeropoints, atmospheric
extinction coefficients, and colour terms, from a set of star match
tables produced by the recipe vmimstandard. The star match tables may
refer to different standard star fields, but they must all be derived
from exposures made with the same filter and the same quadrant.


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

  DO category:            Type:       Explanation:           Required:
  IMG_STAR_MATCH_TABLE    Product     Lust of standard stars    Y
  PHOTOMETRIC_TABLE       Calib       Photometric table         Y

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

  DO category:            Data type:  Explanation:
  PHOTOMETRIC_TABLE       FITS table  Upgraded photometric table

The only product of this recipe is an upgraded PHOTOMETRIC_TABLE,
carrying the newly computed zeropoint, and, if requested, new
extinction and colour coefficients.


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


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

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

   Create an object for the recipe vmimcalphot.

::

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

Parameters
----------

.. py:attribute:: vmimcalphot.param.Extinction

    Compute also extinction coefficient (bool; default: False) [default=False].
.. py:attribute:: vmimcalphot.param.ColorTerm

    Compute also color term (bool; default: False) [default=False].
.. py:attribute:: vmimcalphot.param.UseColorTerm

    Use color term in zeropoint computation (bool; default: False) [default=False].


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

::

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

   vmimcalphot.param.Extinction = False
   vmimcalphot.param.ColorTerm = False
   vmimcalphot.param.UseColorTerm = False


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

::

   import cpl
   vmimcalphot = cpl.Recipe("vmimcalphot")
   [...]
   res = vmimcalphot( ..., param = {"Extinction":False, "ColorTerm":False})


.. 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 and VIMOS Consortium <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 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 and VIMOS Consortium <usd-help@eso.org>
