.. title:: Overview

The KMOS 2.1.0 pipeline
###################################

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

Standard recipes
----------------
:data:`kmos_dark`
   Create master dark frame & bad pixel mask

:data:`kmos_flat`
   Create master flatfield frame and badpixel map

:data:`kmos_illumination`
   Create a frame to correct spatial non-uniformity of flatfield

:data:`kmos_sci_red`
   Reconstruct obj/sky-pairs individually and combine them afterwards

:data:`kmos_std_star`
   Create the telluric correction frame.

:data:`kmos_wave_cal`
   Create a wavelength calibration frame

Additional recipes
--------------------
:data:`kmo_arithmetic`
   Perform basic arithmetic on cubes

:data:`kmo_copy`
   Copy a section of a cube to another cube, image or spectrum

:data:`kmo_fit_profile`
   Fit spectral line profiles as well as spatial profiles with a simple function - for example to measure resolution or find the centre of a source

:data:`kmo_fits_strip`
   Strip noise, rotator and/or empty extensions from a processed KMOS fits frame

:data:`kmo_make_image`
   Collapse a cube to create a spatial image

:data:`kmo_noise_map`
   Generate a noise map from a raw frame

:data:`kmo_rotate`
   Rotate a cube spatially

:data:`kmo_shift`
   Shift a cube spatially

:data:`kmo_sky_mask`
   Create a mask of spatial pixels that indicates which pixels can be considered as sky.

:data:`kmo_stats`
   Perform basic statistics on a KMOS-conform fits-file

:data:`kmos_combine`
   Combine reconstructed cubes

:data:`kmos_extract_spec`
   Extract a spectrum from a cube

:data:`kmos_gen_reflines`
   Create REFLINES calibration file

:data:`kmos_gen_telluric`
   Generate a TELLURIC frame

:data:`kmos_reconstruct`
   Performs the cube reconstruction

:data:`kmos_sky_tweak`
   Removal of OH sky lines

:data:`kmos_test`
   Testing

.. toctree::
   :hidden:

   kmos_dark
   kmos_flat
   kmos_illumination
   kmos_sci_red
   kmos_std_star
   kmos_wave_cal
   kmo_arithmetic
   kmo_copy
   kmo_fit_profile
   kmo_fits_strip
   kmo_make_image
   kmo_noise_map
   kmo_rotate
   kmo_shift
   kmo_sky_mask
   kmo_stats
   kmos_combine
   kmos_extract_spec
   kmos_gen_reflines
   kmos_gen_telluric
   kmos_reconstruct
   kmos_sky_tweak
   kmos_test

.. seealso::

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

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

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