SYNOPSIS

esorex kmo_illumination_flat [OPTIONS] FILE.sof

DESCRIPTION

This recipe creates the spatial non-uniformity calibration frame needed for all three detectors. It must be called after the kmo_wave_cal-recipe, which generates the spectral calibration frame needed in this recipe. As input at least a flatfield frame is required.

Contrary to kmo_illumination it doesn't use flat sky frames but rather the flatfield frames from the internal flat lamp. This recipe can be used if no acceptable flat sky frames are available.

The created product, the illumination correction, can be used as input for kmo_std_star and kmo_sci_red.

BASIC PARAMETERS

--imethod The interpolation method used for reconstruction.

ADVANCED PARAMETERS

--flux Specify if flux conservation should be applied.

--neighborhoodRange Defines the range to search for neighbors during reconstruction

--b_samples The number of samples in spectral direction for the reconstructed cube.

Ideally this number should be greater than 2048, the detector size.

--b_start --b_end Used to define manually the start and end wavelength for the reconstructed cube. By default the internally defined values are used.

--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 corresponding configuration
   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 minimum and maximum pixel values will be rejected.

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

--cpos_rej --cneg_rej --citer see --cmethod='ksigma'

--cmax --cmin see --cmethod='min_max'

--pix_scale Change the pixel scale [arcsec]. Default of 0.2" results into cubes of 14x14pix, a scale of 0.1" results into cubes of 28x28pix, etc.

--suppress_extension If set to TRUE, the arbitrary filename extensions are supressed. If multiple products with the same category are produced, they will be numered consecutively starting from 0.

  Input files:

   DO                    KMOS                                                  
   category              Type   Explanation                    Required #Frames
   --------              -----  -----------                    -------- -------
   FLAT_SKY_FLAT          F2D   Flatlamp-on exposures             Y      1-n   
                                (at least 3 frames recommended)                
   XCAL                   F2D   x calibration frame               Y       1    
   YCAL                   F2D   y calibration frame               Y       1    
   LCAL                   F2D   Wavelength calib. frame           Y       1    
   WAVE_BAND              F2L   Table with start-/end-wavelengths Y       1    

  Output files:

   DO                    KMOS
   category              Type   Explanation
   --------              -----  -----------
   ILLUM_CORR             F2I    Illumination calibration frame   

OPTIONS

--imethod <str>

Method to use for interpolation: ["NN" (nearest neighbour), "lwNN" (linear weighted nearest neighbor), "swNN" (square weighted nearest neighbor), "MS" (Modified Shepard's method), "CS" (Cubic spline)] (str; default: 'CS'). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.imethod [default = CS].

--neighborhoodRange <float>

Defines the range to search for neighbors. in pixels (float; default: 1.001). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.neighborhoodRange [default = 1.001].

--flux <bool>

TRUE: Apply flux conservation. FALSE: otherwise (bool; default: False). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.flux [default = False].

--pix_scale <float>

Change the pixel scale [arcsec]. Default of 0.2" results into cubes of 14x14pix, a scale of 0.1" results into cubes of 28x28pix, etc. (float; default: 0.2). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.pix_scale [default = 0.2].

--suppress_extension <bool>

Suppress arbitrary filename extension. (TRUE (apply) or FALSE (don't apply) (bool; default: False). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.suppress_extension [default = False].

--b_samples <long>

The number of samples in wavelength for the reconstructed cube (long; default: 2048). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.b_samples [default = 2048].

--b_start <float>

The lowest wavelength [um] to use when reconstructing. Derived by default, depending on the band (float; default: -1.0). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.b_start [default = -1.0].

--b_end <float>

The highest wavelength [um] to use when reconstructing. Derived by default, depending on the band (float; default: -1.0). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.b_end [default = -1.0].

--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_illumination_flat.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_illumination_flat.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_illumination_flat.cneg_rej [default = 3.0].

--citer <long>

The number of iterations for kappa-sigma-clipping. (long; default: 3). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.citer [default = 3].

--cmax <long>

The number of maximum pixel values to clip with min/max-clipping. (long; default: 1). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.cmax [default = 1].

--cmin <long>

The number of minimum pixel values to clip with min/max-clipping. (long; default: 1). The full name of this option for the EsoRex configuration file is kmos.kmo_illumination_flat.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.

VERSION

kmo_illumination_flat 1.3.19

AUTHOR

Alex Agudo Berbel <[email protected]>

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