Provided by: cpl-plugin-kmos-doc_1.2.8+dfsg-2_all 
NAME
kmo_dev_setup - Create aligned KMOS files out of test frames
SYNOPSIS
esorex kmo_dev_setup [OPTIONS] FILE.sof
DESCRIPTION
#############################################
### INTENDED FOR PIPELINE DEVELOPERS ONLY ###
#############################################
This recipe is intended to create KMOS conform files in a semi-automatic manner.
It is sufficient to provide a single FITS file and a few parameters to create KMOS conform
FITS files suited for different recipes. Internally it calls repea- tedly the recipe
kmo_fits_stack. There are also parameters that allow to prepare the frames, i.e. early
test out of the lab, in a way they can be processed.
One extension from the input frame is taken, some noise is added automatically in order to
create similar frames for the other extensions.
BASIC PARAMETERS
--type Defines for which recipe the files should be created (´DARK´, ´FLAT_ON´,
´FLAT_OFF´, ´ARC_ON´, ´ARC_OFF´, ´STD´, ´SKY´).
--extension Defines which extension is used to craete frames
--xshift --yshift Shift frames in x and y
--rotangle Sets the ESO OCS ROT NAANGLE keyword in the primary header.
--topcrop --bottomcrop --leftcrop --rightcrop These are cropping the image (filled with
0).
--mainkey --subkey Add individual keywords to primary- or sub-header
--valid Defines if IFUs are active or inactive
--objects Defines if IFUs contain object or sky.
--date Sets the DATE-OBS keword in the primary header.
--filter Sets the filter type for all extensions.
--grating Sets the grating type for all extensions.
Input files:
DO KMOS
category Type Explanation Required #Frames
-------- ----- ----------- -------- -------
DARK or RAW Frame to create Master dark or Y 1
FLAT_ON or Flat-on or
FLAT_OFF or Flat-off or
ARC_ON or Arc-on or
ARC_OFF or Arc-off or
SKY or Sky or
STD or Std star or
GENERIC any other generic KMOS frame
Output files:
DO KMOS
category Type Explanation
-------- ----- -----------
<see comment> RAW Named depending on --type parameter
OPTIONS
--type <str>
FITS type to create (DARK, FLAT_ON, FLAT_OFF, ARC_ON, ARC_OFF, SKY, GENERIC, STD)
(str; default: ´´). The full name of this option for the EsoRex configuration file
is kmos.kmo_dev_setup.type [default = ].
--extension <long>
FITS extension to process (0: primary, 1, 2,...) (long; default: 0). The full name
of this option for the EsoRex configuration file is kmos.kmo_dev_setup.extension
[default = 0].
--xshift <long>
integer shift in x (to the right -> pos) (long; default: 0). The full name of this
option for the EsoRex configuration file is kmos.kmo_dev_setup.xshift [default =
0].
--yshift <long>
integer shift in y (to the top -> pos) (long; default: 0). The full name of this
option for the EsoRex configuration file is kmos.kmo_dev_setup.yshift [default =
0].
--rotangle <float>
Rotator offset angle in degrees (CCW) (float; default: -1.0). The full name of this
option for the EsoRex configuration file is kmos.kmo_dev_setup.rotangle [default =
-1.0].
--topcrop <long>
number of rows to crop at top (long; default: 0). The full name of this option for
the EsoRex configuration file is kmos.kmo_dev_setup.topcrop [default = 0].
--bottomcrop <long>
number of rows to crop at bottom (long; default: 0). The full name of this option
for the EsoRex configuration file is kmos.kmo_dev_setup.bottomcrop [default = 0].
--leftcrop <long>
number of columns to crop at left (long; default: 0). The full name of this option
for the EsoRex configuration file is kmos.kmo_dev_setup.leftcrop [default = 0].
--rightcrop <long>
number of columns to crop at right (long; default: 0). The full name of this option
for the EsoRex configuration file is kmos.kmo_dev_setup.rightcrop [default = 0].
--mainkey <str>
Optional: Additional keywords for primary header (str; default: ´´). The full name
of this option for the EsoRex configuration file is kmos.kmo_dev_setup.mainkey
[default = ].
--subkey <str>
Optional: Additional keywords for sub headers (str; default: ´´). The full name of
this option for the EsoRex configuration file is kmos.kmo_dev_setup.subkey [default
= ].
--valid <str>
Optional: Specify which IFUs are active. Either empty string or string with 8
elements (ones or zeros) e.g: [1;0;1;0;0;...;1] (str; default: ´´). The full name
of this option for the EsoRex configuration file is kmos.kmo_dev_setup.valid
[default = ].
--objects <str>
Optional (STD only): Specify which IFUs contain objects. Either empty string or
string with 8 elements (ones or zeros) e.g: [1;0;1;0;0;...;1] (str; default: ´´).
The full name of this option for the EsoRex configuration file is
kmos.kmo_dev_setup.objects [default = ].
--date <str>
Optional (STD only): Specify the date to save into DATE-OBS e.g:
[2010-01-31T11:53:15.9789] (str; default: ´´). The full name of this option for the
EsoRex configuration file is kmos.kmo_dev_setup.date [default = ].
--filter <str>
filter type (K, H, HK, etc.) (str; default: ´´). The full name of this option for
the EsoRex configuration file is kmos.kmo_dev_setup.filter [default = ].
--grating <str>
grating type (K, H, HK, etc.) (str; default: ´´). The full name of this option for
the EsoRex configuration file is kmos.kmo_dev_setup.grating [default = ].
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_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_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_dev_setup 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