.. title:: Overview

The VIMOS 3.2.3 pipeline
###################################

These pages describe the python interface for the VIMOS pipeline recipes.

Standard recipes
----------------

:data:`vmbias`
   Create a master bias from set of raw bias frames.

:data:`vmdark`
   Create a master dark from set of raw dark frames.

:data:`vmdet`
   Determine RON, gain, and bad pixels from a set of flat field exposures.

:data:`vmifucalib`
   Generate IFU calibrations from a set of flat and arc lamp exposures.

:data:`vmifuscience`
   Extract spectra from an IFU scientific exposure.

:data:`vmifustandard`
   Extract a standard star spectrum.

:data:`vmimflatscreen`
   Create a master screen flat field from set of raw screen flat field frames.

:data:`vmimflatsky`
   Create a master sky flat field from set of raw sky flat field frames.

:data:`vmimobsjitter`
   Reduce and combine a set of jittered imaging exposures.

:data:`vmimobsstare`
   Reduce an imaging science exposure.

:data:`vmimpreimaging`
   Reduce a preimaging science exposure.

:data:`vmimstandard`
   Reduce an imaging standard star exposure.

:data:`vmmoscalib`
   Determination of the extraction mask

:data:`vmmosobsjitter`
   Reduce and combine a set of jittered MOS observations.

:data:`vmmosscience`
   Extraction of scientific spectra

:data:`vmspflat`
   Build master flat field from a set of raw MOS flat fields.

Additional recipes
--------------------

:data:`vmifucombine`
   Combine partial IFU field-of-views reconstructed by vmifuscience from different quadrants.

:data:`vmifucombinecube`
   Rearrange into cube format images of extracted spectraproduced by vmifucalib, vmifuscience, and vmifustandard.

:data:`vmimcalphot`
   Determine photometric calibration from a set of observed standard stars.

:data:`vmmoscombine`
   Combine reduced MOS observations from different OBs.

:data:`vmmosobsstare`
   Reduce a MOS science exposure.

:data:`vmmosstandard`
   Reduce a MOS standard star exposure.

:data:`vmspcaldisp`
   Determine spectral distortion models from flat field and arc lamp exposure.

:data:`vmspphot`
   Apply to IFU or MOS 1D-extracted spectra a flux correction.


.. toctree::
   :hidden:

   vmbias
   vmdark
   vmdet
   vmifucalib
   vmifuscience
   vmifustandard
   vmimflatscreen
   vmimflatsky
   vmimobsjitter
   vmimobsstare
   vmimpreimaging
   vmimstandard
   vmmoscalib
   vmmosobsjitter
   vmmosscience
   vmspflat
   vmifucombine
   vmifucombinecube
   vmimcalphot
   vmmoscombine
   vmmosobsstare
   vmmosstandard
   vmspcaldisp
   vmspphot

.. seealso::

     * The `VIMOS Pipeline User Manual 
       <ftp://ftp.eso.org/pub/dfs/pipelines/vimos/vimos-pipeline-manual-6.9.pdf>`_ in PDF format,

     * an `overview <https://www.eso.org/sci/software/pipelines/>`_
       over the existing ESO pipelines,

     * the `python-cpl <https://packages.python.org/python-cpl>`_ package.
    
Bug reports
===========

If you experience an unexpected behavior of any component of the VIMOS
pipeline recipes package, please, first refer to the list of known problems
and limitations in the pipeline manual of the current VIMOS pipeline
release.

For any other issues or requests, please, send a report to the `ESO User
Support Department <usd-help@eso.org>`_, describing:

 * the VIMOS pipeline version,
 * the version of your OS and C compiler,
 * the exact sequence of actions that were performed before the problem occurred,
 * what were precisely the symptoms and the possible error message(s),
 * whether the problem is repeatable.
