---
name: "kmo_make_image"
section: "7"
platform: "linux"
package: "cpl-plugin-kmos-doc"
version: "2.1.0+dfsg-1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/kmo_make_image"
---

# kmo\_make\_image(7)

Collapse a cube to create a spatial image

## NAME

kmo\_make\_image - Collapse a cube to create a spatial image

## SYNOPSIS

esorex **kmo\_make\_image** \[OPTIONS\] FILE.sof

## DESCRIPTION

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.

### BASIC PARAMETERS

\--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.

### ADVANCED PARAMETERS

\--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

## OPTIONS

- **--range** *\<str\>*

  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 = \].

- **--threshold** *\<float\>*

  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*\].

- **--cmethod** *\<str\>*

  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*\].

- **--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\_make\_image.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\_make\_image.cneg\_rej** \[default = *3.0*\].

- **--citer** *\<int\>*

  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*\].

- **--cmax** *\<int\>*

  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*\].

- **--cmin** *\<int\>*

  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.

## 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 **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_arithmetic/7.md), [*kmo\_copy*(7)](/kmo_copy/7.md), [*kmo\_fit\_profile*(7)](/kmo_fit_profile/7.md), [*kmo\_fits\_strip*(7)](/kmo_fits_strip/7.md), [*kmo\_noise\_map*(7)](/kmo_noise_map/7.md), [*kmo\_rotate*(7)](/kmo_rotate/7.md), [*kmo\_shift*(7)](/kmo_shift/7.md), [*kmo\_sky\_mask*(7)](/kmo_sky_mask/7.md), [*kmo\_stats*(7)](/kmo_stats/7.md), [*kmos\_combine*(7)](/kmos_combine/7.md), [*kmos\_dark*(7)](/kmos_dark/7.md), [*kmos\_extract\_spec*(7)](/kmos_extract_spec/7.md), [*kmos\_flat*(7)](/kmos_flat/7.md), [*kmos\_gen\_reflines*(7)](/kmos_gen_reflines/7.md), [*kmos\_gen\_telluric*(7)](/kmos_gen_telluric/7.md), [*kmos\_illumination*(7)](/kmos_illumination/7.md), [*kmos\_reconstruct*(7)](/kmos_reconstruct/7.md), [*kmos\_sci\_red*(7)](/kmos_sci_red/7.md), [*kmos\_sky\_tweak*(7)](/kmos_sky_tweak/7.md), [*kmos\_std\_star*(7)](/kmos_std_star/7.md), [*kmos\_test*(7)](/kmos_test/7.md), [*kmos\_wave\_cal*(7)](/kmos_wave_cal/7.md)

## VERSION

kmo\_make\_image 2.1.0

## AUTHOR

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

## BUG REPORTS

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\>.

## LICENSE

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
