Provided by: cpl-plugin-kmos-doc_1.2.8+dfsg-2_all 
NAME
kmo_wave_cal - Create a calibration frame encoding the spectral position (i.e. wavelength) of each pixel
on the detector.
SYNOPSIS
esorex kmo_wave_cal [OPTIONS] FILE.sof
DESCRIPTION
This recipe creates the wavelength calibration frame needed for all three detectors. It must be called
after the kmo_flat recipe, which generates the two spatial calibration frames needed in this recipe. As
input a lamp-on frame, a lamp-off frame, the spatial calibration frames and the list with the reference
arclines are required.An additional output frame is the resampled image of the reconstructed arc frame.
All slitlets of all IFUs are aligned one next to the other. This frame serves for quality control. One
can immediately see if the calibration was successful.
The lists of reference arclines are supposed to contain the lines for both available calibration
arc-lamps, i.e. Argon and Neon. The list is supposed to be a F2L KMOS FITS file with three columns: 1.
Reference wavelength 2. Relative strength 3. String either containing “Ar” or “Ne” The recipe extracts,
based on the header keywords, either the applying argon and/or neon emission lines. Below are the plots
of the emission lines for both argon and neon. The marked lines are the ones used for wavelength
calibration.
Furthermore frames can be provided for several rotator angles. In this case the resulting calibration
frames for each detector are repeatedly saved as extension for every angle.
BASIC PARAMETERS
--order The polynomial order to use for the fit of the wavelength solution.
0: (default) The appropriate order is chosen automatically depending on the waveband. Otherwise an order
of 6 is recommended, except for IZ-band, there order 4 should be used.
ADVANCED PARAMETERS
--b_samples The number of samples in spectral direction for the reconstructed cube.
Ideally this number should be greater than 2048, the detector size.
--b_start --b_end Used to define manually the start and end wavelength for the reconstructed cube. By
default the internally defined values are used.
--suppress_extension If set to TRUE, the arbitrary filename extensions are supressed. If multiple
products with the same category are produced, they will be numered consecutively starting from 0.
Input files:
DO KMOS
category Type Explanation Required #Frames
-------- ----- ----------- -------- -------
ARC_ON RAW Arclamp-on exposure Y >=1
ARC_OFF RAW Arclamp-off exposure Y 1
XCAL F2D x calibration frame Y 1
YCAL F2D y calibration frame Y 1
ARC_LIST F2L List of arclines Y 1
FLAT_EDGE F2L Fitted edge parameters Y 1
REF_LINES F2L Reference line table Y 1
WAVE_BAND F2L Table with start-/end-wavelengths Y 1
Output files:
DO KMOS
category Type Explanation
-------- ----- -----------
LCAL F2D Wavelength calibration frame
(3 Extensions)
DET_IMG_WAVE F2D reconstructed arclamp-on exposure
(4 extensions: 3 detector images +
the arclines list table)
OPTIONS
--order <long>
The polynomial order to use for the fit of the wavelength solution. 0: (default) The appropriate
order is chosen automatically depending on the waveband. Otherwise an order of 6 is recommended,
except for IZ- band, there order 4 should be used (long; default: 0). The full name of this option
for the EsoRex configuration file is kmos.kmo_wave_cal.order [default = 0].
--dev_flip <bool>
Set this parameter to TRUE if the wavelengths are ascending on the detector from top to bottom.
(bool; default: False). The full name of this option for the EsoRex configuration file is
kmos.kmo_wave_cal.dev_flip [default = False].
--dev_disp <float>
The expected dispersion of the wavelength in microns/pixel. If the default isn´t changed it will
automatically be selected upon header keywords. (float; default: -1.0). The full name of this
option for the EsoRex configuration file is kmos.kmo_wave_cal.dev_disp [default = -1.0].
--suppress_extension <bool>
Suppress arbitrary filename extension.(TRUE (apply) or FALSE (don´t apply) (bool; default: False).
The full name of this option for the EsoRex configuration file is
kmos.kmo_wave_cal.suppress_extension [default = False].
--b_samples <long>
The number of samples in wavelength for the reconstructed cube (long; default: 2048). The full
name of this option for the EsoRex configuration file is kmos.kmo_wave_cal.b_samples [default =
2048].
--b_start <float>
The lowest wavelength [um] to take into account when reconstructing (default of -1 sets the proper
value for the actual band automatically) (float; default: -1.0). The full name of this option for
the EsoRex configuration file is kmos.kmo_wave_cal.b_start [default = -1.0].
--b_end <float>
The highest wavelength [um] to take into account when reconstructing (default of -1 sets the
proper value for the actual band automatically) (float; default: -1.0). The full name of this
option for the EsoRex configuration file is kmos.kmo_wave_cal.b_end [default = -1.0].
Note that it is possible to create a configuration file containing these options, along with suitable
default values. Please refer to the details provided by the 'esorex --help' command.
SEE ALSO
The full documentation for the kmos pipeline can be downloaded as a PDF file using the following URL:
ftp://ftp.eso.org/pub/dfs/pipelines/kmos/kmos-pipeline-manual-2.9.pdf
An overview over the existing ESO pipelines can be found on the web page
http://www.eso.org/sci/software/pipelines/.
Basic documentation about the EsoRex program can be found at the esorex (1) man page.
It is possible to call the pipelines from python using the python-cpl package. See
http://packages.python.org/python-cpl/index.html for further information.
The other recipes of the kmos pipeline are kmo_dev_setup(7), kmo_copy(7), kmo_flat(7), kmo_fits_check(7),
kmo_sci_red(7), kmo_illumination(7), kmo_fits_stack(7), kmo_noise_map(7), kmo_rotate(7),
kmo_extract_spec(7), kmo_multi_reconstruct(7), kmo_stats(7), kmo_shift(7), kmo_dark(7),
kmo_arithmetic(7), kmo_std_star(7), kmo_fits_strip(7), kmo_combine(7), kmo_illumination_flat(7),
kmo_make_image(7), kmo_sky_tweak(7), kmo_fit_profile(7), kmo_sky_mask(7), kmo_reconstruct(7)
VERSION
kmo_wave_cal 1.2.8
AUTHOR
Alex Agudo Berbel <kmos-spark@mpe.mpg.de>
BUG REPORTS
Please report any problems to kmos-spark@mpe.mpg.de. Alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>.
LICENSE
This file is part of the KMOS Instrument Pipeline Copyright (C) 2002,2003 European Southern Observatory
This program is free software; you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write
to the Free Software Foundation, 51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA