UVES_CAL_MDARK(7)

📦
version 6.1.8 · 2 versions
, in debian bookworm, ubuntu noble

🌙 uves_cal_mdark — the UVES master dark recipe (section 7 of the uves recipes manual, bestie) 🎀

okay so you want a master dark frame and you opened a manpage about it. iconic. let's go 💅

✨ NAME ✨

uves_cal_mdark — Creates the master dark frame. that's the whole job. she's a specialist, not a generalist 🫶

✨ SYNOPSIS ✨

esorex uves_cal_mdark [OPTIONS] FILE.sof

✨ DESCRIPTION ✨

ok so the vibe here is: this recipe builds a master dark frame by taking the median of all the input frames — and those input frames gotta have identical exposure times, no exceptions bestie. symbolically it's giving:

masterdark = median( dark_i ) - masterbias

your input dark frames must have the same tag and the same size, and they must be either (P)DARK_BLUE or (P)DARK_RED. that's non-negotiable. also? a master bias (MASTER_BIAS_xxxx) must be provided for each chip, where xxxx is BLUE, REDL or REDU. yes, every single chip. she's thorough 💅

and then the output depends on which arm you fed her:

  • On blue input the recipe computes one master dark frame. one and done.
  • On red input the recipe produces a master dark frame for each chip — MASTER_(P)DARK_xxxx. so she's multiplying. main character energy fr fr 🔥

✨ OPTIONS ✨

quick heads up bestie: a couple of these appear twice in the original option list (--khigh, --klow, --niter and --stack_method). we are NOT merging them, we are NOT editing them, we're just relaying exactly what's there. do not come for me 🙈
  • --debug <bool> — 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 <float> — 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 <float> — 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]. (yes. again. the list said it twice, so I say it twice 💀)
  • --klow <float> — 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 <float> — 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]. (same energy. twins 🧚)
  • --niter <int> — 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 <int> — 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]. (ok it's a trilogy of duplicates, we move 🫶)
  • --plotter <str> — 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 <str> — 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 <int> — 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 <int> — 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]. (ngl the text here says "X distance" even though the option is border_y — I'm just reading the card as written, don't shoot the messenger 😭)
  • --qc_dark.reg.box_sx <int> — 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 <int> — 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 <int> — 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 <int> — 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 <int> — 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 <str> — 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 <str> — 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]. (last one, I promise 💖)
💡 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:

the whole squad. the friend group. 🌈

✨ VERSION ✨

uves_cal_mdark 6.1.8 — that's the one, bestie ⭐

✨ AUTHOR ✨

Jonas M. Larsen <cpl@eso.org> — thank you for your service, king 👑

✨ BUG REPORTS ✨

Please report any problems to cpl@eso.org. Alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>.

found a bug? tell the grown-ups. they're nice about it, fr fr 🫶

✨ 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

and that's the whole page, bestie 🦋 this cutie came to you from uves_cal_mdark version 6.1.8 in the uves recipes manual, page UVES_CAL_MDARK(7), section 7 — go forth and stack those darks, you absolute icon 💜🌸✨

📦 where this page comes from