Provided by: cpl-plugin-kmos-doc_1.2.8+dfsg-2_all 
NAME
kmo_dark - Create master dark frame & bad pixel mask
SYNOPSIS
esorex kmo_dark [OPTIONS] FILE.sof
DESCRIPTION
This recipe calculates the master dark frame.
It is recommended to provide three or more dark exposures to produce a reason- able master
with associated noise.
BASIC PARAMETERS
--pos_bad_pix_rej --neg_bad_pix_rej Bad pixels above and below defined positive/negative
threshold levels will be flagged and output to the BADPIX_DARK frame (which will go into
the kmo_flat recipe). The number of bad pixels is returned as a QC1 parameter. The two
para- meters can be used to change these thresholds.
--cmethod Following methods of frame combination are available:
* ´ksigma´ (Default)
An iterative sigma clipping. For each position all pixels in the spectrum
are examined. If they deviate significantly, they will be rejected according
to the conditions:
val > mean + stdev * cpos_rej
and
val < mean - stdev * cneg_rej
where --cpos_rej, --cneg_rej and --citer are the corresponding configuration
parameters. In the first iteration median and percentile level are used.
* ´median´
At each pixel position the median is calculated.
* ´average´
At each pixel position the average is calculated.
* ´sum´
At each pixel position the sum is calculated.
* ´min_max´
The specified number of minimum and maximum pixel values will be rejected.
--cmax and --cmin apply to this method.
--file_extensionSet this parameter to TRUE if the EXPTIME keyword should be appended to
the output filenames.
ADVANCED PARAMETERS
--cpos_rej --cneg_rej --citer see --cmethod=´ksigma´
--cmax --cmin see --cmethod=´min_max´
Input files:
DO KMOS
category Type Explanation Required #Frames
-------- ----- ----------- -------- -------
DARK RAW Dark exposures Y 1-n
(at least 3 frames recommended)
Output files:
DO KMOS
category Type Explanation
-------- ----- -----------
MASTER_DARK F2D Calculated master dark frames
BADPIXEL_DARK B2D Associated badpixel frames
OPTIONS
--pos_bad_pix_rej <float>
The positive rejection threshold for bad pixels (float; default: 50.0). The full
name of this option for the EsoRex configuration file is
kmos.kmo_dark.pos_bad_pix_rej [default = 50.0].
--neg_bad_pix_rej <float>
The negative rejection threshold for bad pixels (float; default: 50.0). The full
name of this option for the EsoRex configuration file is
kmos.kmo_dark.neg_bad_pix_rej [default = 50.0].
--file_extension <bool>
Controls if EXPTIME keyword should be appended to product filenames. (bool;
default: False). The full name of this option for the EsoRex configuration file is
kmos.kmo_dark.file_extension [default = False].
--cmethod <str>
Either apply "average", "median", "sum", "min_max." or "ksigma". (str; default:
´ksigma´). The full name of this option for the EsoRex configuration file is
kmos.kmo_dark.cmethod [default = ksigma].
--cpos_rej <float>
The positive rejection threshold for kappa-sigma-clipping (sigma). (float;
default: 3.0). The full name of this option for the EsoRex configuration file is
kmos.kmo_dark.cpos_rej [default = 3.0].
--cneg_rej <float>
The negative rejection threshold for kappa-sigma-clipping (sigma). (float;
default: 3.0). The full name of this option for the EsoRex configuration file is
kmos.kmo_dark.cneg_rej [default = 3.0].
--citer <long>
The number of iterations for kappa-sigma-clipping. (long; default: 3). The full
name of this option for the EsoRex configuration file is kmos.kmo_dark.citer
[default = 3].
--cmax <long>
The number of maximum pixel values to clip with min/max-clipping. (long; default:
1). The full name of this option for the EsoRex configuration file is
kmos.kmo_dark.cmax [default = 1].
--cmin <long>
The number of minimum pixel values to clip with min/max-clipping. (long; default:
1). The full name of this option for the EsoRex configuration file is
kmos.kmo_dark.cmin [default = 1].
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_wave_cal(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_dark 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