XSH_PREDICT(7)

📦 version 3.5.3, in ubuntu jammy, ubuntu noble

✨ NAME ✨

xsh_predict — bestie, this one computes a first guess dispersion solution and order table. That's the whole vibe. 🎯

This is the xsh_predict(7) page from the xshoo recipe lineup, and honestly? She's a lot, but she's iconic.

✨ SYNOPSIS ✨

esorex xsh_predict [OPTIONS] FILE.sof

That's it. That's the summoning ritual. 🪄

✨ DESCRIPTION ✨

Okay so listen — this recipe creates a wavelength solution and an order table. Like, the starter pack for everything downstream. Let's get into what you gotta feed her. 🍓

🦋 Input Frames 🦋

  • [UVB, VIS] One RAW frame (Format = RAW, Tag = FMTCHK_arm)
  • [NIR] Two RAW frames (Format = RAW, Tag = FMTCHK_arm_ON, FMTCHK_arm_OFF)
  • A spectral format table (Format = PRE, Tag = SPECTRAL_FORMAT_TAB_arm)
  • An arc line list (Format = TABLE, Tag = ARC_LINE_LIST_arm)
  • [UVB,VIS,OPTIONAL] A master bias (Format = PRE, Tag = MASTER_BIAS_arm)
  • [UVB,VIS,OPTIONAL] A master dark (Format = PRE, Tag = MASTER_DARK_arm)
  • [OPTIONAL] A reference badpixel map (Format = QUP, Tag = BP_MAP_RP_arm)
  • [OPTIONAL] A non-linear badpixel map (Format = QUP, Tag = BP_MAP_NL_arm)
  • [OPTIONAL] Reference list to monitor line intensity (Tag = ARC_LINE_LIST_INTMON_arm)
  • [poly mode] A theoretical map (Format = TABLE, Tag = THEO_TAB_SING_arm)
  • [physical model mode] A model cfg table (Format = TABLE, Tag = XSH_MOD_CFG_TAB_arm)

🌈 Products 🌈

  • [poly mode] A wavelength solution (Format = TABLE, PRO.CATG = WAVE_TAB_GUESS_arm)
  • An order table, PRO.CATG = ORDER_TAB_GUESS_arm — but only if at least degree+1 points are found in each order. No points, no table, that's the deal. 💀
  • A line identification residual table, PRO.CATG = FMTCHK_RESID_TAB_LINES_arm
  • The bias subtracted formatcheck frame, PRO.CATG = FMTCHK_ON_arm
  • [physical model mode] An optimized model configuration table, PRO.CATG = XSH_MOD_CFG_OPT_FMT_ARM

🎀 What actually happens in there 🎀

  • Prepare the frames.
    • For UVB,VIS:
      • Subtract Master Bias.
      • Subtract Master Dark
    • For NIR:
      • Subtract ON OFF
  • Compute guess order table and wavelength solution

That's the whole glow-up pipeline, periodt. 💅

✨ OPTIONS ✨

Every single one, no skipping, we do not gatekeep here. 🫶

  • --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_predict.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_predict.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_predict.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 you: 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_predict.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). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.pre-overscan-corr [default = 1].
  • --detectarclines-fit-win-hsize <int> — Half window size (HWS) in pixels for the line 2D fitting window (total window size = 2*HWS+1) (int; default: 6). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-fit-win-hsize [default = 6].
  • --detectarclines-search-win-hsize <int> — Half window size (HWS) in pixels for the line search box around the expected position (total window size = 2*HWS+1) [bin units] (int; default: 3). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-search-win-hsize [default = 3].
  • --detectarclines-running-median-hsize <int> — Half window size in pixels (HWS) for the running median box (int; default: 0). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-running-median-hsize [default = 0].
  • --detectarclines-wavesol-deg-lambda <int> — Degree in lambda in the polynomial solution X=f(lambda,order,slit) and Y=f(lambda,order,slit) (POLY mode) (int; default: 5). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-wavesol-deg-lambda [default = 5].
  • --detectarclines-wavesol-deg-order <int> — Degree in order in the polynomial solution X=f(lambda,order,slit) and Y=f(lambda,order,slit) (POLY mode) (int; default: 5). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-wavesol-deg-order [default = 5].
  • --detectarclines-ordertab-deg-y <int> — Degree in Y in the polynomial order tracing X=f(Y) (int; default: 2). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-ordertab-deg-y [default = 2].
  • --detectarclines-min-sn <float> — Minimum signal-to-noise ratio to filter lines [xsh_predict: UVB,VIS=5,NIR=4; xsh_2dmap: UVB=3, VIS=6, NIR=10] (float; default: 5.0). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-min-sn [default = 5.0].
  • --detectarclines-find-lines-center <str> — Method used to find the center of the lines: gaussian, barycenter. Gaussian method applies a Gaussian fit to the line. Barycenter method computes the line centroid. (str; default: gaussian). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-find-lines-center [default = gaussian].
  • --detectarclines-clip-sigma <float> — Kappa value in sigma clipping during the polynomial solution fit (POLY mode) (float; default: 2.0). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-clip-sigma [default = 2.0].
  • --detectarclines-clip-niter <int> — Number of iterations in sigma clipping during the polynomial solution fit (POLY mode) (int; default: 10). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-clip-niter [default = 10].
  • --detectarclines-clip-frac <float> — Minimal fractions of bad pixel allowed in sigma clipping during the polynomial solution fit (POLY mode) (float; default: 0.7). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.detectarclines-clip-frac [default = 0.7].
  • --model-maxit <int> — Number/10 of annealing iterations if in physical model mode. (int; default: 1000). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.model-maxit [default = 1000].
  • --model-anneal-factor <float> — Multiplier applied to the automatic parameter ranges (i.e. when scenario!=0). For routine operations should be 1.0. (physical model mode). (float; default: 1.0). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.model-anneal-factor [default = 1.0].
  • --model-scenario <int> — selects preset flag and range combinations appropriate to common scenarios:
    • 0 — No scenario, input cfg flags and limits used.
    • 1 — scenario appropriate for the startup recipe (large ranges for parameters affecting single ph exposures, dist coeff fixed).
    • 2 — Like 1, but includes parameters affecting all ph positions.
    • 3 — Scenario for use in fine tuning cfg to match routine single pinhole exposures. All parameters affecting 1ph exposures except dist coeffs are included and parameter ranges are small. (For use by predict in 1ph case).
    • 4 — Like 3 but includes parameters affecting all ph positions (Standard for use by predict in 9ph case and 2dmap).

(int; default: 3). The full name of this option for the EsoRex configuration file is xsh.xsh_predict.model-scenario [default = 3].

Heads up bestie: you can totally create a configuration file containing these options, along with suitable default values. Just check 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_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), xsh_wavecal(7) — the whole squad. 👑

✨ VERSION ✨

xsh_predict 3.5.3 — that's the one, no cap. ⭐

✨ AUTHOR ✨

P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, P. Bristow, D. Bramich, A. Modigliani <amodigli@eso.org> — legends, every single one. 🫶

✨ 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>. Found a bug? Tell them, don't suffer in silence bestie. 😭

📜 LICENSE 📜

okay bestie, legal arc incoming, but it's actually kinda wholesome, stay with me 💖

This file is part of the X-shooter Instrument Pipeline Copyright (C) 2006 European Southern Observatory. iconic of them, honestly.

This program is free software — yup, free as in do what you want — 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. dealer's choice, slay 🎀

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. not me warning you in all caps but fr fr, that's the actual vibe. 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., and here's the address, character for character, no edits:

59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
and that's the whole license section, no cap. nothing hidden, nothing extra, just the receipts 🧾

and that's a wrap on XSH_PREDICT(7) bestie 🫶 this whole page is from xsh_predict version 3.5.3, filed under XSH_PREDICT(7) — go forth and predict, you absolute legend 👑✨

📦 where this page comes from