.. title:: Overview

The SINFO 3.0.0 pipeline
###################################

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

Standard recipes
----------------
:data:`sinfo_rec_distortion`
   Finds optical distortions and slitlets distances

:data:`sinfo_rec_detlin`
   Detector's linearity & non linear bad pixels determination.

:data:`sinfo_rec_mdark`
   Master dark and hot pixels mask generation.

:data:`sinfo_rec_mflat`
   Master flat determination

:data:`sinfo_rec_wavecal`
   Wavelength calibration and slitpos determination

:data:`sinfo_rec_jitter`
   Object or STD star or PSF star data reduction

:data:`sinfo_rec_pupil`
   Pupil data reduction

Additional recipes
--------------------
:data:`sinfo_utl_bp_mask_add`
   Add bad pixels masks

:data:`sinfo_utl_cube2ima`
   Cube to image conversion

:data:`sinfo_utl_cube2spectrum`
   Collapse a cube to an image over an aperture

:data:`sinfo_utl_cube_arith`
   Cube arithmetics

:data:`sinfo_utl_cube_combine`
   Coadd cubes in an output cube according to user defined offsets

:data:`sinfo_utl_cube_create`
   Generate a cube

:data:`sinfo_utl_ima_arith`
   Computes result of ima1 op ima2

:data:`sinfo_utl_ima_line_corr`
   Computes result of ima1 op ima2

:data:`sinfo_utl_line_oh_select`
   OH line table creation

:data:`sinfo_utl_skycor`
   Sky lines residuals correction

:data:`sinfo_utl_skymap`
   Flags sky lines as bad pixels, with map generation

:data:`sinfo_utl_spectrum_divide_by_blackbody`
   Spectrum normalization by a blackbody

:data:`sinfo_utl_spectrum_wavelength_shift`
   Spectrum wavelength shift

.. toctree::
   :hidden:

   sinfo_rec_distortion
   sinfo_rec_detlin
   sinfo_rec_mdark
   sinfo_rec_mflat
   sinfo_rec_wavecal
   sinfo_rec_jitter
   sinfo_rec_pupil
   sinfo_utl_bp_mask_add
   sinfo_utl_cube2ima
   sinfo_utl_cube2spectrum
   sinfo_utl_cube_arith
   sinfo_utl_cube_combine
   sinfo_utl_cube_create
   sinfo_utl_ima_arith
   sinfo_utl_ima_line_corr
   sinfo_utl_line_oh_select
   sinfo_utl_skycor
   sinfo_utl_skymap
   sinfo_utl_spectrum_divide_by_blackbody
   sinfo_utl_spectrum_wavelength_shift

.. seealso::

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

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

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