--- name: "uves_cal_mdark" section: "7" platform: "linux" package: "cpl-plugin-uves-doc" version: "6.1.8+dfsg-2" release: "Debian 12 (Bookworm)" platforms: ["linux"] url: "https://new.carta.tech/uves_cal_mdark" --- # uves\_cal\_mdark(7) Creates the master dark frame ## NAME uves\_cal\_mdark - Creates the master dark frame ## SYNOPSIS esorex **uves\_cal\_mdark** \[OPTIONS\] FILE.sof ## DESCRIPTION This recipe creates a master dark frame by taking the median of all input frames which should have identical exposure times. Symbolically,\ masterdark = median( dark\_i ) - masterbias The input dark frames must have same tag and size and must be either (P)DARK\_BLUE or (P)DARK\_RED. Also, a master bias (MASTER\_BIAS\_xxxx) must be provided for each chip (xxxx = BLUE, REDL, REDU). On blue input the recipe computes one master dark frame; on red input the recipe produces a master dark frame for each chip (MASTER\_(P)DARK\_xxxx). ## OPTIONS - **--debug** *\* Whether or not to save intermediate results to local directory (bool; default: False). The full name of this option for the EsoRex configuration file is **uves.debug** \[default = *False*\]. - **--khigh** *\* 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 **uves\_cal\_mdark.khigh** \[default = *5.0*\]. - **--khigh** *\* 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 **uves\_cal\_mdark.khigh** \[default = *5.0*\]. - **--klow** *\* 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 **uves\_cal\_mdark.klow** \[default = *5.0*\]. - **--klow** *\* 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 **uves\_cal\_mdark.klow** \[default = *5.0*\]. - **--niter** *\* Number of kappa sigma iterations, when method is set to ´mean´ (int; default: 5). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.niter** \[default = *5*\]. - **--niter** *\* Number of kappa sigma iterations, when method is set to ´mean´ (int; default: 5). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.niter** \[default = *5*\]. - **--plotter** *\* Any plots produced by the recipe are redirected to the command specified by this parameter. The plotting command must contain the substring ´gnuplot´ and must be able to parse gnuplot syntax on its standard input. Valid examples of such a command may include ´gnuplot -persist´ and ´cat \> mygnuplot$$.gp´. A finer control of the plotting options can be obtained by writing an executable script, e.g. my\_gnuplot.pl, that executes gnuplot after setting the desired gnuplot options (e.g. set terminal pslatex color). To turn off plotting, set this parameter to ´no´ (str; default: ´no´). The full name of this option for the EsoRex configuration file is **uves.plotter** \[default = *no*\]. - **--process\_chip** *\* For RED arm data process the redl, redu, or both chip(s) (str; default: ´both´). The full name of this option for the EsoRex configuration file is **uves.process\_chip** \[default = *both*\]. - **--qc\_dark.reg.border\_x** *\* X distance between the left hand side of the detector and the left hand side of the region \[pix\] (int; default: 100). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.qc\_dark.reg.border\_x** \[default = *100*\]. - **--qc\_dark.reg.border\_y** *\* X distance between the left hand side of the detector and the left hand side of the region \[pix\] (int; default: 100). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.qc\_dark.reg.border\_y** \[default = *100*\]. - **--qc\_dark.reg.box\_sx** *\* Region X size \[pix\] (int; default: 100). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.qc\_dark.reg.box\_sx** \[default = *100*\]. - **--qc\_dark.reg.box\_sy** *\* Region Y size \[pix\] (int; default: 100). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.qc\_dark.reg.box\_sy** \[default = *100*\]. - **--qc\_dark.reg.num\_x** *\* Number of regions along the X axis (where mean/med/rms are computed). (int; default: 4). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.qc\_dark.reg.num\_x** \[default = *4*\]. - **--qc\_dark.reg.num\_y** *\* Number of regions along the Y axis(where mean/med/rms are computed). (int; default: 4). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.qc\_dark.reg.num\_y** \[default = *4*\]. - **--qc\_dark.reg.when** *\* When QC analysis is performed. 0: on each raw frame or 1: on the master frame (int; default: 0). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.qc\_dark.reg.when** \[default = *0*\]. - **--stack\_method** *\* Method used to build master frame (str; default: ´median´). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.stack\_method** \[default = *median*\]. - **--stack\_method** *\* Method used to build master frame (str; default: ´median´). The full name of this option for the EsoRex configuration file is **uves\_cal\_mdark.stack\_method** \[default = *median*\]. 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 uves pipeline can be downloaded as a PDF file using the following URL: - **ftp://ftp.eso.org/pub/dfs/pipelines/uves/uves-pipeline-manual-6.1.8.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 uves pipeline are [*flames\_cal\_mkmaster*(7)](/flames_cal_mkmaster/7.md), [*flames\_cal\_orderpos*(7)](/flames_cal_orderpos/7.md), [*flames\_cal\_predict*(7)](/flames_cal_predict/7.md), [*flames\_cal\_prep\_sff\_ofpos*(7)](/flames_cal_prep_sff_ofpos/7.md), [*flames\_cal\_wavecal*(7)](/flames_cal_wavecal/7.md), [*flames\_obs\_redchain*(7)](/flames_obs_redchain/7.md), [*flames\_obs\_scired*(7)](/flames_obs_scired/7.md), [*flames\_utl\_unpack*(7)](/flames_utl_unpack/7.md), [*uves\_cal\_cd\_align*(7)](/uves_cal_cd_align/7.md), [*uves\_cal\_mbias*(7)](/uves_cal_mbias/7.md), [*uves\_cal\_mflat*(7)](/uves_cal_mflat/7.md), [*uves\_cal\_mflat\_combine*(7)](/uves_cal_mflat_combine/7.md), [*uves\_cal\_mkmaster*(7)](/uves_cal_mkmaster/7.md), [*uves\_cal\_orderpos*(7)](/uves_cal_orderpos/7.md), [*uves\_cal\_predict*(7)](/uves_cal_predict/7.md), [*uves\_cal\_response*(7)](/uves_cal_response/7.md), [*uves\_cal\_tflat*(7)](/uves_cal_tflat/7.md), [*uves\_cal\_wavecal*(7)](/uves_cal_wavecal/7.md), [*uves\_obs\_redchain*(7)](/uves_obs_redchain/7.md), [*uves\_obs\_scired*(7)](/uves_obs_scired/7.md), [*uves\_utl\_ima\_arith*(7)](/uves_utl_ima_arith/7.md), [*uves\_utl\_remove\_crh\_single*(7)](/uves_utl_remove_crh_single/7.md) ## VERSION uves\_cal\_mdark 6.1.8 ## AUTHOR Jonas M. Larsen \ ## BUG REPORTS Please report any problems to cpl@eso.org. Alternatively, you may send a report to the ESO User Support Department \. ## LICENSE This file is part of the FLAMES/UVES Pipeline Copyright (C) 2004, 2005, 2006, 2007 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., 51 Franklin St, Fifth Floor, Boston, MA 02111-1307 USA