trusty (7) kmo_fits_stack.7.gz
NAME
kmo_fits_stack - Creates KMOS conform fits-files
SYNOPSIS
esorex kmo_fits_stack [OPTIONS] FILE.sof
DESCRIPTION
#############################################
### INTENDED FOR PIPELINE DEVELOPERS ONLY ###
#############################################
FITS files to be processed by the KMOS pipeline have to meet certain condi- tions. This recipe is
intended to provide to the user a simple way to test the pipeline with own data, which wasn´t produced by
KMOS itself.
The input set of frame is checked for integrity (do all the frames have the same size, do they correspond
to the desired output type, is there the correct number of files). Then an empty main header is written
with desired keywords.
A keyword consists of the name, data type and value.
Additional keywords can be added either to the empty primary header or to all sub headers.
BASIC PARAMETERS
--type Depending on the type of the FITS file to create different combinations of frames have to be
provided:
* RAW
exactly 3 files tagged as STACK_DATA
* F2D
exactly 3 files tagged as STACK_DATA or
exactly 6 files tagged alternating as STACK_DATA and STACK_NOISE
(beginning with DATA)
* B2D
exactly 3 files tagged as STACK_BADPIX
* F1I, F2I, F3I
as many DATA frames as wanted (at least one) or
as many DATA and NOISE frames as wanted (at least one of each, the number
of STACK_DATA frames has to match the one of STACK_NOISE frames)
* F1S
exactly 1 file tagged as STACK_DATA
* F1L
exactly 1 file tagged as STACK_DATA (either plain text or binary fits
table)
* F2L
exactly 1 file tagged as STACK_DATA (either plain text or binary fits)
table)
--mainkey --subkey Additional keywords can be added either to the empty primary header or to all sub
headers. Provided keywords must have following form:
"keyword;type;value;keyword;type;value" (no spaces inbetween!) Allowed values for type are: string,
int, float, double, bool
--valid With the –valid parameter one can specifiy which values should be handled as invalid by the
pipeline. The keyword ESO OCS ARMi NOTUSED will be set accor- dingly. When it is set to "none" nothing
will be added.
Input files:
DO KMOS
category Type Explanation Required #Frames
-------- ----- ----------- -------- -------
STACK_DATA <none> >= 1 plain FITS files Y 1-n
STACK_NOISE >= 1 plain FITS files N 0,1-n
or
STACK_BADPIXEL 3 plain FITS files Y 3
Output files:
DO KMOS
category Type Explanation
-------- ----- -----------
FITS_STACK RAW or Stacked KMOS FITS file
F1D or
F2D or
B2D or
F1I or
F2I or
F3I or
F1S or
F1L or
F2L
OPTIONS
--type <str>
The KMOS data format type (either "RAW", "F1D", "F2D", "F1I", "F2I", "F3I", "F1S", "F1L", "F2L")
(str; default: ´´). The full name of this option for the EsoRex configuration file is
kmos.kmo_fits_stack.type [default = ].
--format <str>
The format of the columns for "F1L" and "F2L" frames: e.g. "%f;%f;%s" (str; default: ´´). The full
name of this option for the EsoRex configuration file is kmos.kmo_fits_stack.format [default = ].
--title <str>
The titles of the columns for "F1L" and "F2L" frames: e.g. "wavelength;strength" (str; default:
´´). The full name of this option for the EsoRex configuration file is kmos.kmo_fits_stack.title
[default = ].
--filename <str>
Optional: The output filename (.fits will be added as postfix) (str; default: ´FITS_STACK´). The
full name of this option for the EsoRex configuration file is kmos.kmo_fits_stack.filename
[default = FITS_STACK].
--mainkey <str>
Optional: Additional keywords for primary header (str; default: ´´). The full name of this option
for the EsoRex configuration file is kmos.kmo_fits_stack.mainkey [default = ].
--subkey <str>
Optional: Additional keywords for sub headers(This is ignored when category=TRUE) (str; default:
´´). The full name of this option for the EsoRex configuration file is kmos.kmo_fits_stack.subkey
[default = ].
--valid <str>
Optional: Specify which IFUs are active. Either empty string or string with 24 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_fits_stack.valid [default = ].
--category <bool>
Optional: IF a PRO.CATG should be added. (bool; default: False). The full name of this option for
the EsoRex configuration file is kmos.kmo_fits_stack.category [default = False].
--input <str>
Optional: input file (str; default: ´´). The full name of this option for the EsoRex configuration
file is kmos.kmo_fits_stack.input [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_dev_setup(7), kmo_copy(7), kmo_flat(7), kmo_fits_check(7),
kmo_sci_red(7), kmo_illumination(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_fits_stack 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