UVES_CAL_MKMASTER(7)

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

UVES_CAL_MKMASTER(7) — yeah bestie, that's literally us: section 7 of the uves recipes manual, and the icon of this page is uves_cal_mkmaster 💖

🌸 NAME 🌸

uves_cal_mkmaster — creates the master bias/dark/flat frame 🎀

✨ SYNOPSIS ✨

esorex uves_cal_mkmaster [OPTIONS] FILE.sof

💫 DESCRIPTION 💫

okay so uves_cal_mkmaster is lowkey the group-chat admin of the UVES calibration recipes — it doesn't do the whole job itself, it just picks who's on aux tonight:

  • if there's any raw BIAS frame in the mix, it calls uves_cal_mbias 🫶
  • otherwise, if there's any raw DARK frame provided, it calls uves_cal_mdark 🌙
  • otherwise it calls uves_cal_mflat 🌈

that's the whole vibe check, no cap. Pls refer to those recipes for more details 💅

⭐ OPTIONS ⭐

  • --backsub.mmethod <str> — the background measuring method. if it's median, the background gets sampled using the median of a subwindow. if it's minimum, the subwindow minimum value is used. if it's no, no background subtraction happens, periodt. (str; default: median). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.mmethod [default = median].
  • --backsub.npoints <int> — this is the number of columns in interorder space used to sample the background. (int; default: 82). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.npoints [default = 82].
  • --backsub.radiusy <int> — the height (in pixels) of the background sampling window is (2*radiusy + 1). heads up bestie: this parameter is not corrected for binning. (int; default: 2). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.radiusy [default = 2].
  • --backsub.sdegree <int> — degree of interpolating splines. rn only degree = 1 is supported, so that's the only one you're getting 🫠 (int; default: 1). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.sdegree [default = 1].
  • --backsub.smoothx <float> — if spline interpolation is used to measure the background, the x-radius of the post-smoothing window is (smoothx * image_width). here image_width is the image width after binning. if it's negative, the default values get used instead: (25.0/4096) for blue flat-field frames, (50.0/4096) for red flat-field frames, (300.0/4096) for blue science frames and (300.0/4096) for red science frames. (float; default: -1.0). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.smoothx [default = -1.0].
  • --backsub.smoothy <float> — if spline interpolation is used to measure the background, the y-radius of the post-smoothing window is (smoothy * image_height). here image_height is the image height after binning. if it's negative, the defaults kick in: (100.0/2048) for blue flat-field frames, (300.0/2048) for red flat-field frames, (200.0/2048) for blue science frames and (500.0/2048) for red science frames. (float; default: -1.0). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.smoothy [default = -1.0].
  • --clean_traps <bool> — clean detector traps ✨ if TRUE, detector traps are interpolated. the bad pixels are replaced by the average of the nearest good pixels in the same column, or they're just simply marked as bad. the positions of bad pixels are hard-coded (as function of UVES chip). (bool; default: False). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.clean_traps [default = False].
  • --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_mkmaster.khigh [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_mkmaster.klow [default = 5.0].
  • --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_mkmaster.niter [default = 5].
  • --norm_method <str> — method used to build master frame. (str; default: explevel). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.norm_method [default = explevel].
  • --plotter <str> — any plots produced by the recipe get 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_mkmaster.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_mkmaster.qc_dark.reg.border_y [default = 100].
  • --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_mkmaster.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_mkmaster.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_mkmaster.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_mkmaster.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_mkmaster.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_mkmaster.stack_method [default = median].
ok so tea ☕ the original page literally repeats a bunch of these options twice, word for word — --debug, --khigh, --klow, --niter, --plotter, --process_chip and --stack_method all show up in there two times. it's a glitch, not a feature, and nothing is lost by reading each one once 🫶

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 ✨

okay so if you wanna go DEEPER (and bestie, you know you do 💅), the full documentation for the uves pipeline is a whole PDF you can download from here:

ftp://ftp.eso.org/pub/dfs/pipelines/uves/uves-pipeline-manual-6.1.8.pdf

and if you just want the big-picture vibe of all the ESO pipelines that exist, the web page is right here:

https://www.eso.org/sci/software/pipelines/

wanna know the basics of EsoRex itself? that's all sitting pretty in the esorex(1) man page 🫶

oh and ALSO — you can literally call the pipelines from python using the python-cpl package?? like, from python?? iconic. go check https://packages.python.org/python-cpl/index.html for the details 🐍✨

and here's the rest of the uves pipeline family, all the sibling recipes, no cap:

  • flames_cal_mkmaster(7)
  • flames_cal_orderpos(7)
  • flames_cal_predict(7)
  • flames_cal_prep_sff_ofpos(7)
  • flames_cal_wavecal(7)
  • flames_obs_redchain(7)
  • flames_obs_scired(7)
  • flames_utl_unpack(7)
  • uves_cal_cd_align(7)
  • uves_cal_mbias(7)
  • uves_cal_mdark(7)
  • uves_cal_mflat(7)
  • uves_cal_mflat_combine(7)
  • uves_cal_orderpos(7)
  • uves_cal_predict(7)
  • uves_cal_response(7)
  • uves_cal_tflat(7)
  • uves_cal_wavecal(7)
  • uves_obs_redchain(7)
  • uves_obs_scired(7)
  • uves_utl_ima_arith(7)
  • uves_utl_remove_crh_single(7)

⭐ VERSION 👑

uves_cal_mkmaster 6.1.8 — that's the one, that's the version, periodt 💜

🎀 AUTHOR 💖

Jonas M. Larsen &lt;cpl@eso.org&gt; — shoutout to the actual legend who wrote this 🫶

😭 BUG REPORTS 🦋

found something broken? not working the way it should? pls pls pls report it, bestie 🙈

  • send your problems to cpl@eso.org
  • or, if you'd rather, you can send a report to the ESO User Support Department &lt;usd-help@eso.org&gt;

either way works, just tell them, they wanna know fr fr 💌

📜 LICENSE 🌸

okay legal moment, but make it cute. here's the whole thing, verbatim, no edits:

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

okay the caps-lock parts are the scary legal bits and they MEAN it — no warranty, no promises, you're on your own if it goes sideways 💀 but like, it's open source, so slay 🌈

and that's the whole page, bestie!! 🎉 this was uves_cal_mkmaster version 6.1.8 from the FLAMES/UVES pipeline docs — go forth, make your master frames, and be the main character of your own calibration 🧚💖 mwah, bye!! 💅✨

📦 where this page comes from