The vmimpreimaging recipe
===============================================================

.. data:: vmimpreimaging

Synopsis
--------

Reduce a preimaging science exposure.

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

This recipe is used to apply basic reduction steps to the imaging
observation that is preliminary to a MOS observation of the same
field. No source detection is attempted on the image. The image
WCS, together with the component describing the instrument optical
distortions, is converted into the convention followed by VMMPS
(the VIMOS mask preparation software). This set of coefficients,
the so-called CO-matrix used by the SAO WCSTools package, is written
to the header of the reduced image.


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

  DO category:              Type:       Explanation:         Required:
  IMG_PREIMAGING            Raw         Preimaging exposure     Y
  MASTER_BIAS               Calib       Master bias             Y
  IMG_MASTER_SKY_FLAT       Calib       Master sky flat         Y
  PHOT_COEFF_TABLE          Calib       Photometric table       .

  CCD_TABLE                 Calib       Bad pixel table         .


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

  DO category:              Data type:  Explanation:
  IMG_SCIENCE_REDUCED       FITS image  Reduced preimaging exposure

If a photometric table is specified, the magnitude zeropoint, the
atmospheric extinction coefficient, and the colour term are copied
from the photometric table to the header of the reduced image. A CCD
table must be specified in input only if a bad pixel cleaning is
requested.


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


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

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

   Create an object for the recipe vmimpreimaging.

::

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

Parameters
----------

.. py:attribute:: vmimpreimaging.param.BiasMethod

    Bias removal method. (str; default: 'Zmaster') [default="Zmaster"].
.. py:attribute:: vmimpreimaging.param.CleanBadPixel

    Bad pixel correction on reduced science image. (bool; default: False) [default=False].
.. py:attribute:: vmimpreimaging.param.CleanCosmic

    Cosmic ray removal from the input science image. (bool; default: True) [default=True].
.. py:attribute:: vmimpreimaging.param.CosmicsThreshold

    Threshold for cosmic ray candidate selection. (float; default: 4.0) [default=4.0].
.. py:attribute:: vmimpreimaging.param.CosmicsRatio

    Ratio for discrimination of objects and cosmics. (float; default: 2.0) [default=2.0].
.. py:attribute:: vmimpreimaging.param.TemperatureCheck

    Check beam temperature when updating the world coordinate system.  (bool; default: True) [default=True].
.. py:attribute:: vmimpreimaging.param.TemperatureTolerance

    Maximum allowed difference between beam and ambient temperature.  (float; default: 3.0) [default=3.0].


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

::

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

   vmimpreimaging.param.BiasMethod = "Zmaster"
   vmimpreimaging.param.CleanBadPixel = False
   vmimpreimaging.param.CleanCosmic = True
   vmimpreimaging.param.CosmicsThreshold = 4.0
   vmimpreimaging.param.CosmicsRatio = 2.0
   vmimpreimaging.param.TemperatureCheck = True
   vmimpreimaging.param.TemperatureTolerance = 3.0


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

::

   import cpl
   vmimpreimaging = cpl.Recipe("vmimpreimaging")
   [...]
   res = vmimpreimaging( ..., param = {"BiasMethod":"Zmaster", "CleanBadPixel":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 <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 <usd-help@eso.org>
