UVES_CAL_PREDICT(7)

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

💫 uves_cal_predict — the UVES_CAL_PREDICT(7) manual, but make it make sense

okay bestie, so this is a page from the uves recipes corner of the manual universe, and it's about the one and only uves_cal_predict. Let's get into it 💅

✨ NAME ✨

uves_cal_predict — implements the UVES physical model 🦋

🌸 SYNOPSIS 🌸

esorex uves_cal_predict [OPTIONS] FILE.sof

💖 DESCRIPTION 💖

So this recipe literally is the UVES physical model. That's the whole vibe.

Your input files are BLUE or RED arm formatcheck frames, and you spot them by the tag ARC_LAMP_FORM_xxxx, where xxxx=BLUE or RED. You also need a ThAr line reference table, which is tagged LINE_REFER_TABLE. 🎀

What the recipe does: it pulls FITS header data out of those input files — stuff that tells it the instrument setting and the ambient atmospheric conditions — and then, using the model, it predicts the X,Y position of the lines listed in the LINE_REFER_TABLE table that are actually imaging onto the detector. All of that gets stored in a guess order and a guess line table. Iconic, honestly.

Output = a guess order table and a guess line table, per chip. 💫

🫶 bonus round: if you also hand it master format checks tagged MASTER_FORM_xxxx, where xxxx=BLUE or REDL and REDU, the recipe goes ahead and does a stability check too. Slay.

👑 OPTIONS 👑

  • --ccd_rot_angle_off <float> — Offset on CCD rotation angle (float; default: 0.0). The full name of this option for the EsoRex configuration file is uves_cal_predict.ccd_rot_angle_off [default = 0.0].
  • --cd_angle_off <float> — Offset on cross disperser angle (float; default: 0.0). The full name of this option for the EsoRex configuration file is uves_cal_predict.cd_angle_off [default = 0.0].
  • --compute_regression_sw <bool> — Compute regression? (bool; default: True). The full name of this option for the EsoRex configuration file is uves_cal_predict.compute_regression_sw [default = True].
  • --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].
  • --def_pol1 <int> — Polynomial X deg (int; default: 4). The full name of this option for the EsoRex configuration file is uves_cal_predict.def_pol1 [default = 4].
  • --def_pol2 <int> — Polynomial Y deg (int; default: 5). The full name of this option for the EsoRex configuration file is uves_cal_predict.def_pol2 [default = 5].
  • --ech_angle_off <float> — Offset on echelle angle (float; default: 0.0). The full name of this option for the EsoRex configuration file is uves_cal_predict.ech_angle_off [default = 0.0].
  • --kappa <float> — Kappa value in kappa sigma clipping on RESIDUAL between YFIT and Y columns (float; default: 4.5). The full name of this option for the EsoRex configuration file is uves_cal_predict.kappa [default = 4.5].
  • --mbox_x <int> — Match box X size (int; default: 40). The full name of this option for the EsoRex configuration file is uves_cal_predict.mbox_x [default = 40].
  • --mbox_y <int> — Match box Y size (int; default: 40). The full name of this option for the EsoRex configuration file is uves_cal_predict.mbox_y [default = 40].
  • --plotter <str> — Any plots produced by the recipe get redirected to the command you name here. ⚠️ 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´. Want finer control over your plotting options? Write 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 entirely, 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].
  • --tol <float> — Tolerance in kappa sigma clipping on RESIDUAL between YFIT and Y columns (float; default: 2.0). The full name of this option for the EsoRex configuration file is uves_cal_predict.tol [default = 2.0].
  • --trans_x <float> — Detector translation along X (float; default: 0.0). The full name of this option for the EsoRex configuration file is uves_cal_predict.trans_x [default = 0.0].
  • --trans_y <float> — Detector translation along Y (float; default: 0.0). The full name of this option for the EsoRex configuration file is uves_cal_predict.trans_y [default = 0.0].

And lowkey the best part: you can make a configuration file holding all of these options plus suitable default values. Check the details in the 'esorex --help' command, bestie. 🧚

🌈 SEE ALSO 🌈

The full documentation for the uves pipeline can be downloaded as a PDF file using this URL:

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

An overview over the existing ESO pipelines lives on this web page: https://www.eso.org/sci/software/pipelines/.

Basic documentation about the EsoRex program is over at the esorex (1) man page.

You can also call the pipelines from python using the python-cpl package. Peep https://packages.python.org/python-cpl/index.html for further information. 💜

And the other recipes of the uves pipeline, in all their glory: 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_mkmaster(7), uves_cal_orderpos(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_predict 6.1.8

🎀 AUTHOR 🎀

Andrea Modigliani <cpl@eso.org> 💌

🙈 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>. They genuinely wanna hear it, no cap.

🔥 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

okay that's the whole page, you ate it, go predict some lines bestie 🦋

signing off — this was uves_cal_predict version 6.1.8, page UVES_CAL_PREDICT(7), and that's the tea 💅

📦 where this page comes from