kmo_stats(7)

Usage

esorex kmo_stats [OPTIONS] FILE.sof

Overview

This recipe performs basic statistics on KMOS-conform data-frames of type F2D, F1I, F2I and F3I either with or without noise and RAW. Optionally a 2D mask can be provided to define a region on which the statistics should be calculated on (mask 0: exclude pixel, mask 1: include pixel). A mask can’t be provided for statistics on F1I frames.

The output is stored in a vector of length 11. The vector represents following values:
1. Number of pixels
2. Number of finite pixels
3. Mean
4. Standard Deviation
5. Mean with iterative rejection (i.e. mean & sigma are calculated iterati-
vely, each time rejecting pixels more than +/-N sigma from the mean)
6. Standard Deviation with iterative rejection
7. Median
8. Mode (i.e. the peak in a histogram of pixel values)
9. Noise (a robust estimate given by the standard deviation from the nega-
tive side of the histogram of pixel values)
10. Minimum
11. Maximum

The same numerical operations are applied to the noise as with the data itself.

Basic parameters

--ext These parameters specify with extensions to process. The value 0, which is default, calulates all extensions.

Advanced parameters

--cpos_rej --cneg_rej --citer An iterative sigma clipping is applied in order to calculate the mode (using kmo_stats). 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 In the first iteration median and percentile level are used.

Input files:

DO DO KMOS
category group Type Explanation Required #Frames
-------- ----- ----- ----------- -------- -------
<none or any> - F3I or The datacubes Y 1
F2I or
F1I or
F2D or
B2D or
RAW
<none or any> - F2I or The mask N 0,1
F2D or
B2D or
RAW

Output files:

DO KMOS
category Type Explanation
-------- ----- -----------
STATS F1I Calculated statistics parameters

Options

--ext <int>: The extension the stats should be calculated of. Zero is default and calculates the stats of all extensions (int; default: 0). The full name of this option for the EsoRex configuration file is kmos.kmo_stats.ext [default = 0].

--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_stats.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_stats.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_stats.citer [default = 3].

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.