.. title:: Overview

The VISIR 3.5.1 pipeline
###################################

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

Standard recipes
----------------
:data:`visir_img_combine`
   Images combination recipe

:data:`visir_img_phot`
   Sensitivity computation

:data:`visir_img_ff`
   Flat field recipe

:data:`visir_img_dark`
   Dark recipe

:data:`visir_img_trans`
   Instrument Transmission recipe

:data:`visir_spc_obs`
   Spectroscopic Observation recipe

:data:`visir_spc_obs_ech`
   Spectroscopic observation recipe in Echelle mode

:data:`visir_spc_wcal`
   Spectroscopic wavelength calibration recipe

:data:`visir_spc_wcal_ech`
   Spectroscopic wavelength calibration recipe in Echelle

:data:`visir_spc_phot`
   Sensitivity computation in spectroscopy

:data:`visir_spc_phot_ech`
   Sensitivity computation in echelle spectroscopy

Additional recipes
--------------------
:data:`visir_util_convert_pos`
   Conversion of object position(s) from matching pairs of nodded object files + sextractor tables

:data:`visir_util_repack`
   Conversion of raw CUBE2 or BURST images to on- and off-cubes

:data:`visir_util_spc_std_cat`
   Generate a FITS catalog of spectroscopic standard stars

:data:`visir_util_img_std_cat`
   Convert ASCII-file(s) to a FITS standard star catalog

:data:`visir_util_find_beam`
   Find the positive beam in a nodded image

:data:`visir_util_inputs`
   Conversion of raw images to nodded images

:data:`visir_util_convert_weight`
   Conversion between different weight maps

:data:`visir_util_spc_txt2fits`
   Generate spectrum calibration FITS tables

:data:`visir_util_clip`
   Kappa-sigma clipping of outliers for each pixel

:data:`visir_util_weight2error`
   Conversion of a swarp weight map to an error map

:data:`visir_util_undistort`
   Correct the distortion in spectral data

:data:`visir_util_join`
   Extend the final product with extensions containing its error map, bad pixel map and weight or contribution map

:data:`visir_img_burst`
   Images burst combination recipe

.. toctree::
   :hidden:

   visir_img_combine
   visir_img_phot
   visir_img_ff
   visir_img_dark
   visir_img_trans
   visir_spc_obs
   visir_spc_obs_ech
   visir_spc_wcal
   visir_spc_wcal_ech
   visir_spc_phot
   visir_spc_phot_ech
   visir_util_convert_pos
   visir_util_repack
   visir_util_spc_std_cat
   visir_util_img_std_cat
   visir_util_find_beam
   visir_util_inputs
   visir_util_convert_weight
   visir_util_spc_txt2fits
   visir_util_clip
   visir_util_weight2error
   visir_util_undistort
   visir_util_join
   visir_img_burst

.. seealso::

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

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

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

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

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

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