.. title:: Overview

The XSHOO 3.5.0 pipeline
###################################

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

Standard recipes
----------------
:data:`xsh_2dmap`
   Creates a wavelength and spatial resampling solution, a clean arc line list

:data:`xsh_flexcomp`
   Compute the flexure of the instrument

:data:`xsh_mbias`
   Create the master bias frame

:data:`xsh_mdark`
   Create the master dark frame

:data:`xsh_mflat`
   Create the master flat and the orders edges traces table frames

:data:`xsh_orderpos`
   Create the orders centre traces table file

:data:`xsh_predict`
   Compute a first guess dispersion solution and order table

:data:`xsh_respon_slit_nod`
   Reduce STD star frames in SLIT configuration and nod mode

:data:`xsh_respon_slit_offset`
   Compute the response function in SLIT and on/off mode

:data:`xsh_respon_slit_stare`
   Compute the response function in SLIT stare mode

:data:`xsh_scired_ifu_offset`
   Reduce science IFU on-off exposures and build a 3D cube

:data:`xsh_scired_ifu_stare`
   Reduce science IFU stare exposures and build a 3D cube

:data:`xsh_scired_slit_nod`
   Reduce science frames in SLIT configuration and nod mode

:data:`xsh_scired_slit_offset`
   Reduce science exposure in SLIT configuration and on/off mode

:data:`xsh_scired_slit_stare`
   Reduce science exposure in SLIT configuration and stare mode

:data:`xsh_wavecal`
   Compute arclines tilt and instrument resolution

Additional recipes
--------------------
:data:`xsh_cfg_recover`
   Optimizes a model configuration to match data taken after a major format change

:data:`xsh_geom_ifu`
   Produces the spatial geometry of the IFU pattern on the sky

:data:`xsh_lingain`
   Computes detector's gain/linearity-map

:data:`xsh_scired_ifu_offset_drl`
   Reduce science exposure in IFU configuration and on/off mode

:data:`xsh_scired_ifu_stare_drl`
   Reduce science exposure in IFU configuration and stare mode

:data:`xsh_util_physmod`
   Generate physical model products

.. toctree::
   :hidden:

   xsh_2dmap
   xsh_flexcomp
   xsh_mbias
   xsh_mdark
   xsh_mflat
   xsh_orderpos
   xsh_predict
   xsh_respon_slit_nod
   xsh_respon_slit_offset
   xsh_respon_slit_stare
   xsh_scired_ifu_offset
   xsh_scired_ifu_stare
   xsh_scired_slit_nod
   xsh_scired_slit_offset
   xsh_scired_slit_stare
   xsh_wavecal
   xsh_cfg_recover
   xsh_geom_ifu
   xsh_lingain
   xsh_scired_ifu_offset_drl
   xsh_scired_ifu_stare_drl
   xsh_util_physmod

.. seealso::

     * The `XSHOO Pipeline User Manual 
       <ftp://ftp.eso.org/pub/dfs/pipelines/xshoo/xshoo-pipeline-manual-12.1.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 XSHOO
pipeline recipes package, please, first refer to the list of known problems
and limitations in the pipeline manual of the current XSHOO pipeline
release.

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

 * the XSHOO 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.