.TH XSH_MDARK "7" "3.5.3" "xsh_mdark" "xshoo recipes" .SH NAME xsh_mdark \- Create the master dark frame .SH SYNOPSIS esorex .B xsh_mdark [OPTIONS] FILE.sof .SH DESCRIPTION This recipe creates a master dark frame Input Frames : \- A set of n RAW frames (Format=RAW, n >=3, Tag = DARK_arm) \- [UVB,VIS] A master bias frame (Format=PRE, Tag = MASTER_BIAS_arm) \- [OPTIONAL] A map of non linear bad pixels (Format=QUP, Tag = BP_MAP_NL_arm) \- [OPTIONAL] A map of reference bad pixels (Format = QUP,RAW, Tag = BP_MAP_RP_arm) Products : \- A master dark frame (Format=PRE, PRO.CATG = MASTER_DARK_arm) A dark frame, (Format=PRE, PRO.CATG = DARK_arm) .SH OPTIONS .TP \fB\-\-keep\-temp\fR \fI\fR If \'no\', temporary files are deleted. (str; default: \'no\'). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.keep\-temp\fR [default = \fIno\fR]. .TP \fB\-\-debug\-level\fR \fI\fR Additional xshooter debug level. One of \'none\', \'low\', \'medium\', \'high\' (str; default: \'none\'). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.debug\-level\fR [default = \fInone\fR]. .TP \fB\-\-time\-stamp\fR \fI\fR Add timestamp to product file name. (bool; default: False). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.time\-stamp\fR [default = \fIFalse\fR]. .TP \fB\-\-decode\-bp\fR \fI\fR Integer representation of the bits to be considered bad when decoding the bad pixel mask pixel values. Most frequent codes relevant for the user: 0: good pixel, 8: pick\-up noise, 16: cosmic\-ray removed, 32: cosmic\-ray unremoved, 128: calibration file defect, 256: hot pixel, 512: dark pixel, 4096: A/D converted saturation, 32768: non linear pixel, 1048576: extrapolated flux in NIR, 4194304: Interpolated flux during extraction. (int; default: 2144337919). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.decode\-bp\fR [default = \fI2144337919\fR]. .TP \fB\-\-pre\-overscan\-corr\fR \fI\fR pre\-overscan correction. 0: no correction 1: mean overscan correction 2: mean prescan correction 3: (mean pre+mean overscan)/2 correction (int; default: 1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.pre\-overscan\-corr\fR [default = \fI1\fR]. .TP \fB\-\-stack\-method\fR \fI\fR Method used to build master frame. (str; default: \'median\'). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.stack\-method\fR [default = \fImedian\fR]. .TP \fB\-\-klow\fR \fI\fR Kappa used to clip low level values, when method is set to \'mean\' (float; default: 5.0). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.klow\fR [default = \fI5.0\fR]. .TP \fB\-\-khigh\fR \fI\fR Kappa used to clip high level values, when method is set to \'mean\' (float; default: 5.0). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.khigh\fR [default = \fI5.0\fR]. .TP \fB\-\-bp\-output\fR \fI\fR Flag indicating whether the noise bad pixel map is to be computed (bool; default: False). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.bp\-output\fR [default = \fIFalse\fR]. .TP \fB\-\-crh\-clip\-kappa\fR \fI\fR Kappa value in sigma clipping during CRH rejection using multiple frames (float; default: \-1.0). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.crh\-clip\-kappa\fR [default = \fI\-1.0\fR]. .TP \fB\-\-crh\-clip\-niter\fR \fI\fR Number of iterations in sigma clipping during CRH rejection using multiple frames (int; default: 3). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.crh\-clip\-niter\fR [default = \fI3\fR]. .TP \fB\-\-crh\-clip\-frac\fR \fI\fR Minimal ratio of points accepted / total in sigma clipping during CRH rejection using multiple frames (float; default: 0.7). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.crh\-clip\-frac\fR [default = \fI0.7\fR]. .TP \fB\-\-noise\-clip\-kappa\fR \fI\fR Multiple of sigma in sigma clipping (float; default: 9.0). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.noise\-clip\-kappa\fR [default = \fI9.0\fR]. .TP \fB\-\-noise\-clip\-niter\fR \fI\fR Number of iterations in sigma clipping (int; default: 5). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.noise\-clip\-niter\fR [default = \fI5\fR]. .TP \fB\-\-noise\-clip\-frac\fR \fI\fR Minimal fractions of bad pixel allowed (float; default: 0.7). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.noise\-clip\-frac\fR [default = \fI0.7\fR]. .TP \fB\-\-noise\-clip\-diff\fR \fI\fR Minimum relative change in sigma for sigma clipping (float; default: 0.0). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.noise\-clip\-diff\fR [default = \fI0.0\fR]. .TP \fB\-\-noise\-lower\-rejection\fR \fI\fR Lower rejection percentile to flag bad pixels via noise (float; default: 10.0). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.noise\-lower\-rejection\fR [default = \fI10.0\fR]. .TP \fB\-\-noise\-higher\-rejection\fR \fI\fR Upper rejection percentile to flag bad pixels via noise (float; default: 10.0). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.noise\-higher\-rejection\fR [default = \fI10.0\fR]. .TP \fB\-\-ref1_llx\fR \fI\fR Lower left X of reference region (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.ref1_llx\fR [default = \fI\-1\fR]. .TP \fB\-\-ref1_lly\fR \fI\fR Lower left Y of reference region (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.ref1_lly\fR [default = \fI\-1\fR]. .TP \fB\-\-ref1_urx\fR \fI\fR Upper right X of reference region (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.ref1_urx\fR [default = \fI\-1\fR]. .TP \fB\-\-ref1_ury\fR \fI\fR Upper right Y of reference region (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.ref1_ury\fR [default = \fI\-1\fR]. .TP \fB\-\-ron_llx\fR \fI\fR Lower left X of reference region to measure RON (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.ron_llx\fR [default = \fI\-1\fR]. .TP \fB\-\-ron_lly\fR \fI\fR Lower left Y of reference region to measure RON (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.ron_lly\fR [default = \fI\-1\fR]. .TP \fB\-\-ron_urx\fR \fI\fR Upper right X of reference region to measure RON (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.ron_urx\fR [default = \fI\-1\fR]. .TP \fB\-\-ron_ury\fR \fI\fR Upper right Y of reference region to measure RON (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.ron_ury\fR [default = \fI\-1\fR]. .TP \fB\-\-ron_hsize\fR \fI\fR Sampling area size (int; default: 4). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.ron_hsize\fR [default = \fI4\fR]. .TP \fB\-\-ron_nsamples\fR \fI\fR Number of random samples (int; default: 100). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.ron_nsamples\fR [default = \fI100\fR]. .TP \fB\-\-fpn_llx\fR \fI\fR Lower left reference area X coordinate for Fixed Pattern Noise computation (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.fpn_llx\fR [default = \fI\-1\fR]. .TP \fB\-\-fpn_lly\fR \fI\fR Lower left reference area Y coordinate for Fixed Pattern Noise computation (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.fpn_lly\fR [default = \fI\-1\fR]. .TP \fB\-\-fpn_urx\fR \fI\fR Upper right reference area X coordinate for Fixed Pattern Noise computation (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.fpn_urx\fR [default = \fI\-1\fR]. .TP \fB\-\-fpn_ury\fR \fI\fR Upper right reference area Y coordinate for Fixed Pattern Noise computation (int; default: \-1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.fpn_ury\fR [default = \fI\-1\fR]. .TP \fB\-\-fpn_hsize\fR \fI\fR Sample size for Fixed Pattern Noise computation (int; default: 4). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.fpn_hsize\fR [default = \fI4\fR]. .TP \fB\-\-fpn_nsamples\fR \fI\fR Number of sampling points for Fixed Pattern Noise computation (int; default: 100). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_mdark.fpn_nsamples\fR [default = \fI100\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 xshoo pipeline can be downloaded as a PDF file using the following URL: .IP .B ftp://ftp.eso.org/pub/dfs/pipelines/xshoo/xshoo\-pipeline\-manual\-12.1.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 xshoo pipeline are .IR xsh_2dmap (7), .IR xsh_cfg_recover (7), .IR xsh_flexcomp (7), .IR xsh_geom_ifu (7), .IR xsh_lingain (7), .IR xsh_mbias (7), .IR xsh_mflat (7), .IR xsh_orderpos (7), .IR xsh_predict (7), .IR xsh_respon_slit_nod (7), .IR xsh_respon_slit_offset (7), .IR xsh_respon_slit_stare (7), .IR xsh_scired_ifu_offset (7), .IR xsh_scired_ifu_offset_drl (7), .IR xsh_scired_ifu_stare (7), .IR xsh_scired_ifu_stare_drl (7), .IR xsh_scired_slit_nod (7), .IR xsh_scired_slit_offset (7), .IR xsh_scired_slit_stare (7), .IR xsh_util_physmod (7), .IR xsh_wavecal (7) .SH VERSION xsh_mdark 3.5.3 .SH AUTHOR P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani .SH BUG REPORTS Please report any problems to amodigli@eso.org. Alternatively, you may send a report to the ESO User Support Department . .SH LICENSE This file is part of the X\-shooter Instrument Pipeline Copyright (C) 2006 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