XSH_SCIRED_SLIT_OFFSET(7)

📦 version 3.5.3, in ubuntu jammy, ubuntu noble

💖 XSH_SCIRED_SLIT_OFFSET 💖

okay bestie, welcome to the manual page for xsh_scired_slit_offset, from the xshoo recipes collection (that's the XSH_SCIRED_SLIT_OFFSET(7) situation, iykyk). grab a snack, this one's a whole journey ✨

🌸 NAME 🌸

xsh_scired_slit_offset — reduce science exposure in SLIT configuration and on/off mode. that's it, that's the vibe 💅

🦋 SYNOPSIS 🦋

esorex xsh_scired_slit_offset [OPTIONS] FILE.sof

✨ DESCRIPTION ✨

so this recipe reduces science exposure in SLIT configuration and on/off mode. slay.

🎀 Input Frames 🎀

here's the little shopping list of what it wants, no cap:

  • a set of n science frames (n even), with Tag = STD_FLUX_SLIT_OFFSET_arm, SKY_SLIT_arm
  • a spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)
  • a master flat frame (Tag = MASTER_FLAT_SLIT_arm)
  • an order table frame (Tag = ORDER_TABLE_EDGES_SLIT_arm)
  • a wavelength calibration solution frame (Tag = WAVE_TAB_2D_arm)
  • [OPTIONAL] a table with dispersion coefficients (Tag = DISP_TAB_arm)
    • it is required if -rectify-conserve-flux=TRUE
  • [OPTIONAL] a non-linear badpixel map (Tag = BP_MAP_NL_arm)
  • [OPTIONAL] a reference badpixel map (Tag = BP_MAP_RP_arm)
  • [OPTIONAL] the instrument response table (Tag = RESPONSE_MERGE1D_SLIT_arm)
  • [OPTIONAL] an atmospheric extinction table (Tag = ATMOS_EXT_arm)
  • [OPTIONAL] a telluric mask (Tag = TELL_MASK_arm)
  • [OPTIONAL] the instrument master response table (Tag = MRESPONSE_MERGE1D_SLIT_arm)
💡 if both master and individual response are provided, the individual response is the one that wins. the master one is just there, being a backup bestie. 🙈

👑 Products 👑

and here's what you get back, the whole glow-up:

  • PREFIX_ORDER2D_arm — extracted spectrum, order-by-order, 2D
  • PREFIX_ORDER1D_arm — extracted spectrum, order-by-order, 1D
  • PREFIX_MERGE2D_arm — merged spectrum, 2D
  • PREFIX_MERGE1D_arm — merged spectrum, 1D
  • PREFIX_SKY_arm — 2D sky frame
  • SKY_SLIT_ORDER2D_arm — 2D sky image (order-by-order)
  • SKY_SLIT_MERGE2D_arm — 2D sky image (merged)
  • PREFIX_WAVE_MAP_arm — wave map image
  • PREFIX_SLIT_MAP_arm — slit map image
  • where PREFIX is SCI, FLUX, TELL if the input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC
  • [OPTIONAL, if response and atm ext are provided] PREFIX_FLUX_ORDER2D_arm (2 dimension)
  • [OPTIONAL, if response and atm ext are provided] PREFIX_FLUX_ORDER1D_arm (1 dimension)
  • [OPTIONAL, if response and atm ext are provided] PREFIX_FLUX_MERGE2D_arm (2 dimension)
  • [OPTIONAL, if response and atm ext are provided] PREFIX_FLUX_MERGE1D_arm (1 dimension)

💅 OPTIONS 💅

okay this is the long part, but like… we're doing it. every single flag, no skipping, periodt. 🔥

  • --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_scired_slit_offset.keep-temp [default = no].
  • --debug-level <str> — extra xshooter debug level, bestie. one of ´none´, ´low´, ´medium´, ´high´ (str; default: ´none´). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.debug-level [default = none].
  • --time-stamp <bool> — adds a timestamp to the product file name, cute. (bool; default: False). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.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 that actually matter to 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_scired_slit_offset.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_scired_slit_offset.pre-overscan-corr [default = 1].
  • --removecrhsingle-sigmalim <float> — Poisson fluctuation threshold to flag CRHs (peep van Dokkum, PASP,113,2001,p1420-27) (float; default: 20.0). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.removecrhsingle-sigmalim [default = 20.0].
  • --removecrhsingle-flim <float> — minimum contrast between the Laplacian image and the fine structure image that a point must have to be flagged as CRH. (see van Dokkum, PASP,113,2001,p1420-27) (float; default: 2.0). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.removecrhsingle-flim [default = 2.0].
  • --removecrhsingle-niter <int> — max number of iterations (int; default: 4). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.removecrhsingle-niter [default = 4].
  • --rectify-kernel <str> — name of the Interpolation Kernel Used. possible values are: tanh, sinc, sinc2, lanczos, hamming, hann. (str; default: ´tanh´). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.rectify-kernel [default = tanh].
  • --rectify-radius <float> — Rectify Interpolation radius [bin units]. (float; default: 2.0). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.rectify-radius [default = 2.0].
  • --rectify-bin-lambda <float> — wavelength step in the output spectrum [nm] (float; default: -1.0). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.rectify-bin-lambda [default = -1.0].
  • --rectify-bin-slit <float> — spatial step along the slit in the output spectrum [arcsec] (float; default: -1.0). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.rectify-bin-slit [default = -1.0].
  • --localize-method <str> — localization method (MANUAL, MAXIMUM, GAUSSIAN) used to detect the object centroid and height on the slit (str; default: ´MANUAL´). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.localize-method [default = MANUAL].
  • --localize-chunk-nb <int> — number of chunks in the full spectrum to localize the object (int; default: 10). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.localize-chunk-nb [default = 10].
  • --localize-thresh <float> — threshold relative to the peak intensity below which the edges of the object are detected for MAXIMUM localization (float; default: 0.1). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.localize-thresh [default = 0.1].
  • --localize-deg-lambda <int> — degree in lambda in the localization polynomial expression slit=f(lambda), used only for MAXIMUM and GAUSSIAN (int; default: 0). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.localize-deg-lambda [default = 0].
  • --localize-slit-position <float> — object position on the slit for MANUAL localization [arcsec] (float; default: 0.0). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.localize-slit-position [default = 0.0].
  • --localize-slit-hheight <float> — object half height on the slit for MANUAL localization [arcsec] (float; default: 2.0). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.localize-slit-hheight [default = 2.0].
  • --localize-kappa <float> — kappa value for sigma clipping in the localization polynomial fit (float; default: 3.0). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.localize-kappa [default = 3.0].
  • --localize-niter <int> — number of iterations for sigma clipping in the localization polynomial fit (int; default: 3). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.localize-niter [default = 3].
  • --localize-use-skymask <bool> — TRUE if we want to mask sky lines using SKY_LINE_LIST file. (bool; default: False). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.localize-use-skymask [default = False].
  • --stdextract-interp-hsize <int> — half size of mask used to define object cross order profile (int; default: 30). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.stdextract-interp-hsize [default = 30].
  • --combinenod-method <str> — combination method for nodded frames (MEDIAN, MEAN) (str; default: ´MEAN´). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.combinenod-method [default = MEAN].
  • --gen-sky <bool> — if TRUE a 2D sky frame, a 2D rectified, a 2D merged sky are generated (bool; default: True). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.gen-sky [default = True].
  • --cut-uvb-spectrum <bool> — TRUE if recipe cuts the UVB spectrum at 556 nm (dichroich) (bool; default: True). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.cut-uvb-spectrum [default = True].
  • --generate-SDP-format <bool> — TRUE if additional files should be generated in Science Data Product (SDP) format. (bool; default: False). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.generate-SDP-format [default = False].
  • --dummy-association-keys <int> — sets the number of dummy (empty) ASSONi, ASSOCi and ASSOMi keywords to create. (int; default: 0). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_slit_offset.dummy-association-keys [default = 0].
🌈 heads up bestie: you can totally create a configuration file containing these options, along with suitable default values. just peep the details provided by the 'esorex --help' command. 💖

👀 SEE ALSO 👀

okay bestie, you want the whole lore? the full documentation for the xshoo pipeline is available as a PDF, and you can grab it right here:

ftp://ftp.eso.org/pub/dfs/pipelines/xshoo/xshoo-pipeline-manual-12.1.pdf

and if you wanna peek at the other pipelines ESO has been cooking, the overview lives at:

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

basic deets on the EsoRex program? that's all in the esorex (1) man page, go read it, it's right there.

and the very fun part — you can literally call the pipelines from python using the python-cpl package 🐍✨ more info at:

https://packages.python.org/python-cpl/index.html

also here's the whole friend group, the other recipes of the xshoo pipeline, say hi to all of them: 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_stare(7), xsh_util_physmod(7), xsh_wavecal(7)

🌟 VERSION 🌟

xsh_scired_slit_offset 3.5.3

no cap, that's the one you're running 💅

👑 AUTHOR 👑

the icons who made this happen: P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani — you can reach them at <amodigli@eso.org> 🫶

🐛 BUG REPORTS 🐛

found something broken? not the vibe, we gotta fix it. please report any problems to <amodigli@eso.org>. alternatively, you can send a report to the ESO User Support Department at <usd-help@eso.org> 💌 they're literally there for this.

📜 LICENSE 📜

okay so legal stuff, but make it cute:

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

fr fr though, that "WITHOUT ANY WARRANTY" bit is not a joke, it's doing heavy lifting. no promises, bestie 😭

and that's the whole page, you made it to the end 🎀 this was xsh_scired_slit_offset version 3.5.3, living in the manual as XSH_SCIRED_SLIT_OFFSET(7) — go forth and reduce those slit offset frames, main character energy only ✨💖🦋

📦 where this page comes from