XSH_WAVECAL(7)

✨ XSH_WAVECAL ✨

okay bestie, welcome to xsh_wavecal, a recipe from the xshoo pipeline (that's the manual family it lives in, XSH_WAVECAL(7)). this one's whole job? detecting and following arc lines in a fully illuminated slit frame, then figuring out the arclines tilt and the instrument resolution. it's giving detective energy but for photons. 💅

---

🌸 NAME 🌸

xsh_wavecal — compute arclines tilt and instrument resolution. yes ma'am, that's the whole vibe. 🎀

---

🦋 SYNOPSIS 🦋

esorex xsh_wavecal [OPTIONS] FILE.sof

---

💖 DESCRIPTION 💖

so this recipe detects and follows arc lines in a fully illuminated slit frame. that's it, that's the mission. 🔥

🧚 Input Frames (the guest list, no plus-ones unless marked)

• Raw frame (Tag = ARC_SLIT_arm)
• Arc Line List (Tag = ARC_LINE_LIST_arm)
• Master Bias (Tag = MASTER_BIAS_arm)
• [OPTIONAL] Master Dark (Tag = MASTER_DARK_arm)
• Order Table (Tag = ORDER_TABLE_EDGES_arm)
• [poly mode] Wave Solution (Tag = WAVE_TAB_2D_arm)
• [poly mode] Theoretical Map (Tag = THEO_TAB_spec_arm, spec=SING/IFU)
• [physical model mode] Model cfg tab (Tag = XSH_MOD_CFG_TAB_arm)
  • [OPTIONAL] A non-linear badpixel map (Tag = BP_MAP_NL_arm)
  • [OPTIONAL] A reference badpixel map (Tag = BP_MAP_RP_arm)
• [OPTIONAL-To compute spectral resolution] Dispersion Table Frame (Tag = DISP_TAB_arm)

Prepare PRE structures. (yes that's literally what it says, bestie — prepare them. 💫)

then the glow-up sequence:

• Subtract the master Dark (UVB, VIS and NIR)
• Substract the master Bias (UVB and VIS)
• Divide by Flat.

then:

• Detect and follow arc lines. 🔍

👑 Products (the receipts)

• Wavelength solution, PRO.CATG = WAVE_TAB_ARC_SLIT_arm [if poly mode]
• Linetilt list, PRO.CATG = TILT_TAB_SLIT_arm
• Residuals table, PRO.CATG = RESID_TAB_GOOD_LINES_arm
• Wave Map, PRO.CATG = WAVE_MAP_arm [if model-wavemap-compute=TRUE]
• In case of IFU mode cdata previous producs repat for each IFU slices
• Arc frame, Bias subtracted in PRE format, PRO.CATG = ARC_BIAS_SUBTRACT_arm
• If arm=UVB/VIS and PRO.CATG=ARC_NIR_ON if arm=NIR
• Arc frame, Bias subtracted, FLAT-FIELDED, PRO.CATG = WAVECAL_FLATFIELDED_arm

---

💅 OPTIONS 💅

every single one, bestie. i'm not skipping a single flag, that's not the energy we bring. 🫶

• --keep-temp <str> — if it's ´no´, temporary files get deleted. (str; default: ´no´). the full name of this option for the EsoRex configuration file is xsh.xsh_wavecal.keep-temp [default = no].
• --debug-level <str> — extra xshooter debug level, pick from ´none´, ´low´, ´medium´, ´high´. (str; default: ´none´). full name for EsoRex config: xsh.xsh_wavecal.debug-level [default = none].
• --time-stamp <bool> — slap a timestamp onto the product file name, cute. (bool; default: False). full name for EsoRex config: xsh.xsh_wavecal.time-stamp [default = False].
• --decode-bp <int> — integer representation of the bits to be considered bad when decoding the bad pixel mask pixel values. the most frequent codes relevant for the user, memorise these fr fr: 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). full name for EsoRex config: xsh.xsh_wavecal.decode-bp [default = 2144337919].
• --pre-overscan-corr <int> — pre-overscan correction. 0: no correction, 1: mean overscan correction, 2: mean prescan correction, 3: (mean pre+mean overscan)/2 correction. (int; default: 1). full name for EsoRex config: xsh.xsh_wavecal.pre-overscan-corr [default = 1].
• --followarclines-search-window-half-size <int> — half window size (HWS) in pixels (Y axis) of the search window for each line. (int; default: 13). full name for EsoRex config: xsh.xsh_wavecal.followarclines-search-window-half-size [default = 13].
• --followarclines-order-edges-mask <int> — nb of pixels suppressed (X) from edges of search window. (int; default: 3). full name for EsoRex config: xsh.xsh_wavecal.followarclines-order-edges-mask [default = 3].
• --followarclines-min-sn <float> — minimum Signal over Noise ratio at center to keep the line (6 for IFU, 15 for SLIT). (float; default: -1.0). full name for EsoRex config: xsh.xsh_wavecal.followarclines-min-sn [default = -1.0].
• --tilt-clip-kappa <float> — multiple of sigma in sigma clipping for evaluating tilt. (float; default: 2.5). full name for EsoRex config: xsh.xsh_wavecal.tilt-clip-kappa [default = 2.5].
• --tilt-clip-niter <int> — number of iterations in sigma clipping for evaluating tilt. (int; default: 5). full name for EsoRex config: xsh.xsh_wavecal.tilt-clip-niter [default = 5].
• --tilt-clip-frac <float> — minimal fraction of points accepted / total in sigma clipping for evaluating tilt. (float; default: 0.7). full name for EsoRex config: xsh.xsh_wavecal.tilt-clip-frac [default = 0.7].
• --specres-clip-kappa <float> — multiple of sigma in sigma clipping for evaluating spectral resolution. (float; default: 2.5). full name for EsoRex config: xsh.xsh_wavecal.specres-clip-kappa [default = 2.5].
• --specres-clip-niter <int> — number of iterations in sigma clipping for evaluating spectral resolution. (int; default: 5). full name for EsoRex config: xsh.xsh_wavecal.specres-clip-niter [default = 5].
• --specres-clip-frac <float> — minimal fraction of points accepted / total in sigma clipping for evaluating spectral resolution. (float; default: 0.7). full name for EsoRex config: xsh.xsh_wavecal.specres-clip-frac [default = 0.7].

heads up bestie: you can totally make a configuration file holding all these options plus suitable default values. the details are in the 'esorex --help' command. go read it, i'll wait. 💜

---

🌈 SEE ALSO 🌈

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

ftp://ftp.eso.org/pub/dfs/pipelines/xshoo/xshoo-pipeline-manual-12.1.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 in the esorex (1) man page.

you can also 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 xshoo pipeline, aka the whole friend group, are: xsh_2dmap(7), xsh_cfg_recover(7), xsh_flexcomp(7), xsh_geom_ifu(7), xsh_lingain(7), xsh_mbias(7), xsh_mdark(7), xsh_mflat(7), xsh_orderpos(7), xsh_predict(7), xsh_respon_slit_nod(7), xsh_respon_slit_offset(7), xsh_respon_slit_stare(7), xsh_scired_ifu_offset(7), xsh_scired_ifu_offset_drl(7), xsh_scired_ifu_stare(7), xsh_scired_ifu_stare_drl(7), xsh_scired_slit_nod(7), xsh_scired_slit_offset(7), xsh_scired_slit_stare(7), xsh_util_physmod(7).

---

⭐ VERSION ⭐

xsh_wavecal 3.5.3

---

🎀 AUTHOR 🎀

L.Guglielmi <amodigli@eso.org> — shoutout to the icon who made this. 👑

---

🦋 BUG REPORTS 🦋

please report any problems to amodigli@eso.org. alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>. if something's cursed, tell them, not me. 😭

---

💀 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.

---

and that's the whole page, bestie!! 🫶 this was xsh_wavecal version 3.5.3, served fresh from the xshoo recipes, dated 3.5.3, filed under XSH_WAVECAL(7). now go calibrate something and slay. 💖✨🌈