.. title:: Overview

The FORS 4.11.12 pipeline
###################################

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

Standard recipes
----------------
:data:`fors_bias`
   Compute the master bias frame

:data:`fors_dark`
   Compute master dark frame

:data:`fors_img_sky_flat`
   Compute master img_sky_flat frame

:data:`fors_img_screen_flat`
   Compute master screen flat frame

:data:`fors_img_science`
   Reduce scientific exposure

:data:`fors_zeropoint`
   Compute zeropoint

:data:`fors_sumflux`
   Integrate flux from all or part of the input frame

:data:`fors_calib`
   Determination of the extraction mask

:data:`fors_pmos_calib`
   Determination of the extraction mask

:data:`fors_science`
   Extraction of scientific spectra

:data:`fors_extract`
   Extraction of scientific spectra

:data:`fors_pmos_extract`
   Extraction of scientific spectra

Additional recipes
--------------------
:data:`fors_wave_calib_lss`
   Derive dispersion relation from long-slit arc lamp frame

:data:`fors_resample`
   Resample input spectra at constant wavelength step

:data:`fors_config`
   Creation of FORS recipes configuration tables

:data:`fors_extract_objects`
   Extract objects in slit spectra

:data:`fors_wave_calib`
   Derive dispersion relation from rectified arc lamp frame

:data:`fors_detect_objects`
   Detect objects in slit spectra

:data:`fors_pmos_science`
   Extraction of scientific spectra

:data:`fors_extract_slits`
   Spatial rectification of spectral image

:data:`fors_remove_bias`
   Subtract bias from input frame

:data:`fors_subtract_sky`
   Subtract sky from scientific spectra

:data:`fors_photometry`
   Compute corrected flatfield

:data:`fors_normalise_flat`
   Normalise master flat spectrum

:data:`fors_subtract_sky_lss`
   Subtract sky from calibrated long slit exposure

:data:`fors_trace_flat`
   Determine spectral curvature model

:data:`fors_flatfield`
   Flat field correction of input frame

:data:`fors_detect_spectra`
   Detect MOS/MXU spectra on CCD

:data:`fors_align_sky_lss`
   Upgrade wavelength solution using sky lines

:data:`fors_align_sky`
   Upgrade wavelength solution using sky lines

:data:`fors_spec_mflat`
   Computes master spectroscopic flat, removing bias first

.. toctree::
   :hidden:

   fors_bias
   fors_dark
   fors_img_sky_flat
   fors_img_screen_flat
   fors_img_science
   fors_zeropoint
   fors_sumflux
   fors_calib
   fors_pmos_calib
   fors_science
   fors_extract
   fors_pmos_extract
   fors_wave_calib_lss
   fors_resample
   fors_config
   fors_extract_objects
   fors_wave_calib
   fors_detect_objects
   fors_pmos_science
   fors_extract_slits
   fors_remove_bias
   fors_subtract_sky
   fors_photometry
   fors_normalise_flat
   fors_subtract_sky_lss
   fors_trace_flat
   fors_flatfield
   fors_detect_spectra
   fors_align_sky_lss
   fors_align_sky
   fors_spec_mflat

.. seealso::

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

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

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