.. title:: Overview

The VISIR 4.4.2 pipeline
###################################

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

Standard recipes
----------------
:data:`visir_img_dark`
   Dark recipe

:data:`visir_img_ff`
   Flat field recipe

:data:`visir_img_reduce`
   Combines a stack of chopped, jittered and/or nodded exposures and can compute the sensitivity for standard star observations

:data:`visir_img_trans`
   Instrument Transmission recipe

:data:`visir_old_spc_obs`
   Old DRS detector: Spectroscopic Observation recipe

:data:`visir_old_spc_obs_ech`
   Old DRS detector: Spectroscopic Observation recipe in Echelle mode

:data:`visir_old_spc_phot`
   Old DRS detector: Sensitivity computation in spectroscopy

:data:`visir_old_spc_phot_ech`
   Old DRS detector: Sensitivity computation in echelle spectroscopy

:data:`visir_old_spc_wcal`
   Old DRS detector: Spectroscopic wavelength calibration recipe

:data:`visir_old_spc_wcal_ech`
   Old DRS detector: Spectroscopic wavelength calibration recipe in Echelle

:data:`visir_spc_reduce`
   Spectroscopic Observation recipe

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

Additional recipes
--------------------
:data:`visir_old_img_combine`
   Old DRS detector: Images combination recipe

:data:`visir_old_img_phot`
   Old DRS detector: Sensitivity computation

:data:`visir_old_util_destripe`
   Old DRS detector: Attempt to remove stripes in spectral data

:data:`visir_util_apply_calib`
   Attempt to remove stripes in spectral data

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

:data:`visir_util_convert_weight`
   Conversion between different weight maps

:data:`visir_util_detect_shift`
   2012

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

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

:data:`visir_util_qc`
   Prepares qc parameters from data where the beam has been deteteced and bad images have been removed

:data:`visir_util_run_swarp`
   Run swarp program to coadd images.

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

:data:`visir_util_spc_txt2fits`
   Generate spectrum calibration FITS tables

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

.. toctree::
   :hidden:

   visir_img_dark
   visir_img_ff
   visir_img_reduce
   visir_img_trans
   visir_old_spc_obs
   visir_old_spc_obs_ech
   visir_old_spc_phot
   visir_old_spc_phot_ech
   visir_old_spc_wcal
   visir_old_spc_wcal_ech
   visir_spc_reduce
   visir_util_repack
   visir_old_img_combine
   visir_old_img_phot
   visir_old_util_destripe
   visir_util_apply_calib
   visir_util_clip
   visir_util_convert_weight
   visir_util_detect_shift
   visir_util_img_std_cat
   visir_util_join
   visir_util_qc
   visir_util_run_swarp
   visir_util_spc_std_cat
   visir_util_spc_txt2fits
   visir_util_undistort

.. 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 <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 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.