.TH KMOS_ILLUMINATION "7" "2.1.0" "kmos_illumination" "kmos recipes" .SH NAME kmos_illumination \- Create a frame to correct spatial non\-uniformity of flatfield .SH SYNOPSIS esorex .B kmos_illumination [OPTIONS] FILE.sof .SH 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 sky or flat, a master dark, a master flat and the spatial and spectral calibration frames are required. .PP The created product, the illumination correction, can be used as input for kmo_std_star and kmo_sci_red. .PP Input files: DO CATG Type Explanation Required #Frames \-\-\-\-\-\-\-\- \-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\- \-\-\-\-\-\-\- FLAT_SKY F2D Sky exposures Y 1\-n (at least 3 frames recommended) or FLAT_ON F2D Flat exposures Y 1\-n (at least 3 frames recommended) MASTER_DARK F2D Master dark Y 1 MASTER_FLAT F2D Master flat Y 1 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 FLAT_EDGE F2L Table with fitted slitlet edges N 0,1 Output files: DO CATG Type Explanation \-\-\-\-\-\-\-\- \-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\- ILLUM_CORR F2I Illumination calibration frame If FLAT_EDGE is provided: SKYFLAT_EDGE F2L Frame containing parameters of fitted slitlets of all IFUs of all detectors .SH OPTIONS .TP \fB\-\-used_flat_type\fR \fI\fR Type (sky/lamp) of input to use: (only if 2 types in input) (str; default: \'sky\'). The full name of this option for the EsoRex configuration file is \fBkmos.kmos_illumination.used_flat_type\fR [default = \fIsky\fR]. .TP \fB\-\-imethod\fR \fI\fR 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 \fBkmos.kmos_illumination.imethod\fR [default = \fICS\fR]. .TP \fB\-\-neighborhoodRange\fR \fI\fR Range (pixels) to search for neighbors (float; default: 1.001). The full name of this option for the EsoRex configuration file is \fBkmos.kmos_illumination.neighborhoodRange\fR [default = \fI1.001\fR]. .TP \fB\-\-range\fR \fI\fR The spectral ranges to combine when collapsing the reconstructed cubes. 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 \fBkmos.kmos_illumination.range\fR [default = \fI\fR]. .TP \fB\-\-flux\fR \fI\fR TRUE: Apply flux conservation. FALSE: otherwise (bool; default: False). The full name of this option for the EsoRex configuration file is \fBkmos.kmos_illumination.flux\fR [default = \fIFalse\fR]. .TP \fB\-\-add\-all\fR \fI\fR FALSE: omit 1st FLAT_SKY frame (acquisition), TRUE: don\'t perform any checks, add them all (bool; default: False). The full name of this option for the EsoRex configuration file is \fBkmos.kmos_illumination.add\-all\fR [default = \fIFalse\fR]. .TP \fB\-\-pix_scale\fR \fI\fR 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 \fBkmos.kmos_illumination.pix_scale\fR [default = \fI0.2\fR]. .TP \fB\-\-suppress_extension\fR \fI\fR Suppress filename extension. (TRUE (apply) or FALSE (don\'t apply) (bool; default: False). The full name of this option for the EsoRex configuration file is \fBkmos.kmos_illumination.suppress_extension\fR [default = \fIFalse\fR]. .TP \fB\-\-b_samples\fR \fI\fR The number of samples in wavelength for the reconstructed cube (int; default: 2048). The full name of this option for the EsoRex configuration file is \fBkmos.kmos_illumination.b_samples\fR [default = \fI2048\fR]. .TP \fB\-\-cmethod\fR \fI\fR Apply "average", "median", "sum", "min_max." or "ksigma". (str; default: \'ksigma\'). The full name of this option for the EsoRex configuration file is \fBkmos.kmos_illumination.cmethod\fR [default = \fIksigma\fR]. .TP \fB\-\-cpos_rej\fR \fI\fR 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 \fBkmos.kmos_illumination.cpos_rej\fR [default = \fI3.0\fR]. .TP \fB\-\-cneg_rej\fR \fI\fR 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 \fBkmos.kmos_illumination.cneg_rej\fR [default = \fI3.0\fR]. .TP \fB\-\-citer\fR \fI\fR The number of iterations for kappa\-sigma\-clipping. (int; default: 3). The full name of this option for the EsoRex configuration file is \fBkmos.kmos_illumination.citer\fR [default = \fI3\fR]. .TP \fB\-\-cmax\fR \fI\fR 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 \fBkmos.kmos_illumination.cmax\fR [default = \fI1\fR]. .TP \fB\-\-cmin\fR \fI\fR 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 \fBkmos.kmos_illumination.cmin\fR [default = \fI1\fR]. .TP \fB\-\-det\fR \fI\fR Only reduce the specified detector (int; default: 0). The full name of this option for the EsoRex configuration file is \fBkmos.kmos_illumination.detector\fR [default = \fI0\fR]. .TP \fB\-\-angle\fR \fI\fR Only reduce the specified angle (float; default: 370.0). The full name of this option for the EsoRex configuration file is \fBkmos.kmos_illumination.angle\fR [default = \fI370.0\fR]. .PP 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. .SH SEE ALSO The full documentation for the kmos pipeline can be downloaded as a PDF file using the following URL: .IP .B ftp://ftp.eso.org/pub/dfs/pipelines/kmos/kmos\-pipeline\-manual\-2.9.pdf .PP An overview over the existing ESO pipelines can be found on the web page \fBhttps://www.eso.org/sci/software/pipelines/\fR. .PP Basic documentation about the EsoRex program can be found at the esorex (1) man page. .PP It is possible to call the pipelines from python using the python\-cpl package. See \fBhttps://packages.python.org/python\-cpl/index.html\fR for further information. .PP The other recipes of the kmos pipeline are .IR kmo_arithmetic (7), .IR kmo_copy (7), .IR kmo_fit_profile (7), .IR kmo_fits_strip (7), .IR kmo_make_image (7), .IR kmo_noise_map (7), .IR kmo_rotate (7), .IR kmo_shift (7), .IR kmo_sky_mask (7), .IR kmo_stats (7), .IR kmos_combine (7), .IR kmos_dark (7), .IR kmos_extract_spec (7), .IR kmos_flat (7), .IR kmos_gen_reflines (7), .IR kmos_gen_telluric (7), .IR kmos_reconstruct (7), .IR kmos_sci_red (7), .IR kmos_sky_tweak (7), .IR kmos_std_star (7), .IR kmos_test (7), .IR kmos_wave_cal (7) .SH VERSION kmos_illumination 2.1.0 .SH AUTHOR Alex Agudo Berbel, Yves Jung .SH BUG REPORTS Please report any problems to usd\-help@eso.org. Alternatively, you may send a report to the ESO User Support Department . .SH 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