DOKK / manpages / debian 10 / cpl-plugin-kmos-doc / kmo_make_image.7.en
KMO_MAKE_IMAGE(7) kmos recipes KMO_MAKE_IMAGE(7)

kmo_make_image - Collapse a cube to create a spatial image

esorex kmo_make_image [OPTIONS] FILE.sof

This recipe collapses a cube along the spectral axis using rejection. By default all spectral slices are averaged.

Errors are propagated for the same spectral ranges as for the input data if a noise map is provided.

--range The spectral range can be delimited to one or several sub-ranges like "1.8,1.9" or "1.8,1.9; 2.0,2.11"

--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 wished 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 min and max pixel values will be rejected.


--cmax and --cmin apply to this method.

--threshold Optionally an OH spectrum can be provided. In this case a threshold can be defined. The wavelengths of values above the threshold level in the OH spectrum are omitted in the input frame. This parameter can be combined with the --range parameter. Negative threshold values are ignored.

Own spectra can be converted into the required F1S KMOS FITS format for the OH spectrum using kmo_fits_stack.

--cpos_rej --cneg_rej --citer
see --cmethod=´ksigma´ --cmax --cmin
see --cmethod=´min_max´


Input files:
DO CATG Type Explanation Required #Frames
------- ----- ----------- -------- -------
<none or any> F3I data frame Y 1
<none or any> F1S OH line spectrum N 0,1


Output files:
DO CATG Type Explanation
------- ----- -----------
MAKE_IMAGE F2I Collapsed data cubes

The spectral ranges to combine. e.g."x1_start,x1_end;x2_start,x2_end" (microns) (str; default: ´´). The full name of this option for the EsoRex configuration file is kmos.kmo_make_image.range [default = ].
The OH threshold level (%) (float; default: 0.1). The full name of this option for the EsoRex configuration file is kmos.kmo_make_image.threshold [default = 0.1].
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_make_image.cmethod [default = ksigma].
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_make_image.cpos_rej [default = 3.0].
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_make_image.cneg_rej [default = 3.0].
The number of iterations for kappa-sigma-clipping. (int; default: 3). The full name of this option for the EsoRex configuration file is kmos.kmo_make_image.citer [default = 3].
The number of maximum pixel values to clip with min/max-clipping. (int; default: 1). The full name of this option for the EsoRex configuration file is kmos.kmo_make_image.cmax [default = 1].
The number of minimum pixel values to clip with min/max-clipping. (int; default: 1). The full name of this option for the EsoRex configuration file is kmos.kmo_make_image.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.

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 https://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 https://packages.python.org/python-cpl/index.html for further information.

The other recipes of the kmos pipeline are kmo_arithmetic(7), kmo_copy(7), kmo_fit_profile(7), kmo_fits_strip(7), kmo_noise_map(7), kmo_rotate(7), kmo_shift(7), kmo_sky_mask(7), kmo_stats(7), kmos_combine(7), kmos_dark(7), kmos_extract_spec(7), kmos_flat(7), kmos_gen_reflines(7), kmos_gen_telluric(7), kmos_illumination(7), kmos_reconstruct(7), kmos_sci_red(7), kmos_sky_tweak(7), kmos_std_star(7), kmos_test(7), kmos_wave_cal(7)

kmo_make_image 2.1.0

Alex Agudo Berbel <usd-help@eso.org>

Please report any problems to usd-help@eso.org. Alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>.

This file is part of the CRIRES 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, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

2.1.0 kmo_make_image