XSH_UTIL_PHYSMOD(7)

💫 xsh_util_physmod — aka XSH_UTIL_PHYSMOD(7) 💫

okay bestie, sit down, hydrate, because we're about to talk about the xshoo recipe that makes physical model products and honestly? it's giving ✨foundational✨.

---

🌸 NAME 🌸

xsh_util_physmod — generate physical model products. that's it, that's the job, no cap.

---

🎀 SYNOPSIS 🎀

esorex xsh_util_physmod [OPTIONS] FILE.sof

yes the [OPTIONS] goes before the FILE.sof, we don't make the rules, we just read them 💅

---

🦋 DESCRIPTION 🦋

so this recipe generates the theoretical and the spectral format tables. and possibly the model based wave map too, if you're feeling spicy 🔥

the sof file contains the names of the input FITS file tagged with XSH_MOD_CFG_TAB_arm.

tagged with ARC_LINE_LIST_arm. (yes that's the whole sentence, she's a little mysterious, we love her anyway 🫶)

this recipe has the following products, and bestie, we're listing all of them:

• Model order traces for nine pinholes (PRO CATG = THEO_TAB_MULT_arm)
• Model order traces for nine pinholes (PRO CATG = THEO_TAB_IFU_arm)
• Model order traces for central pinhole (PRO CATG = THEO_TAB_SING_arm)
• Spectral format table (PRO CATG = SPECTRAL_FORMAT_TAB_arm)
• Wave map image (PRO CATG = WAVE_MAP_arm)
• Slit map image (PRO CATG = SLIT_MAP_arm)

---

✨ OPTIONS ✨

one bullet per flag, no skipping, no summarising, we keep every single crumb 🍓

• --keep-temp <str> — if ´no´, temporary files are deleted. (str; default: ´no´). The full name of this option for the EsoRex configuration file is xsh.xsh_util_physmod.keep-temp [default = no].
• --debug-level <str> — additional xshooter debug level. one of ´none´, ´low´, ´medium´, ´high´ (str; default: ´none´). The full name of this option for the EsoRex configuration file is xsh.xsh_util_physmod.debug-level [default = none].
• --time-stamp <bool> — add timestamp to product file name. (bool; default: False). The full name of this option for the EsoRex configuration file is xsh.xsh_util_physmod.time-stamp [default = False].
• --decode-bp <int> — integer representation of the bits to be considered bad when decoding the bad pixel mask pixel values. Most frequent codes relevant for the user:
  • 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). The full name of this option for the EsoRex configuration file is xsh.xsh_util_physmod.decode-bp [default = 2144337919].

• --binx <int> — X binning (int; default: 1). The full name of this option for the EsoRex configuration file is xsh.xsh_model.binx [default = 1].
• --biny <int> — X binning (int; default: 1). The full name of this option for the EsoRex configuration file is xsh.xsh_model.biny [default = 1].
• --spectral-format-tab <bool> — generate spectral format table (bool; default: False). The full name of this option for the EsoRex configuration file is xsh.xsh_model.spectral_format_tab [default = False].
• --wavemap <bool> — generate slit and wave maps (time consuming) (bool; default: False). The full name of this option for the EsoRex configuration file is xsh.xsh_model.wavemap [default = False].

💡 heads up bestie: 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 xshoo pipeline can be downloaded as a PDF file using the following URL:

ftp://ftp.eso.org/pub/dfs/pipelines/xshoo/xshoo-pipeline-manual-12.1.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 xshoo pipeline 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_wavecal(7)

like, the whole friend group is here 🫶

---

💜 VERSION 💜

xsh_util_physmod 3.5.3

---

👑 AUTHOR 👑

Andrea Modigliani <amodigli@eso.org>

---

🙈 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>. they're nice, they won't judge you, fr fr.

---

⭐ 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

---

okay that's the whole page bestie, we ate and left absolutely zero crumbs 🍓✨ this was xsh_util_physmod version 3.5.3, page XSH_UTIL_PHYSMOD(7) — slay, go generate some physical model products 💅🌈