XSH_SCIRED_IFU_OFFSET_DRL(7)

📦 version 3.5.3, in ubuntu jammy, ubuntu noble

🎀 XSH_SCIRED_IFU_OFFSET_DRL(7) 🎀

okay bestie, welcome to the xshoo recipes section of the manual 💖 this is XSH_SCIRED_IFU_OFFSET_DRL(7) and it's a whole vibe. grab a snack, we're doing this.

✨ NAME ✨

xsh_scired_ifu_offset_drl — Reduce science exposure in IFU configuration and on/off mode 🦋

🌸 SYNOPSIS 🌸

esorex xsh_scired_ifu_offset_drl [OPTIONS] FILE.sof

💫 DESCRIPTION 💫

So this recipe reduces science exposure in IFU configuration and on/off mode. that's the whole job. no cap.

Input Frames :

  • A set of 2xn Science frames, Tag = OBJECT_IFU_OFFSET_arm, SKY_IFU_arm
  • A spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)
  • A master flat frame (Tag = MASTER_FLAT_IFU_arm)
  • An order table frame (Tag = ORDER_TABLE_EDGES_IFU_arm)
  • 3 wave solution frames, one per slitlet (Tag = WAVE_TAB_ARC_IFU_slitlet_arm)
    • where slitlet is DOWN, CEN or UP ⬆️ (yes the acronym really is that long, we move)
  • [OPTIONAL] A dispersion table (Tag = DISP_TAB_IFU_arm)
  • [OPTIONAL] A badpixel map (Tag = BADPIXEL_MAP_arm)

Products :

  • 3 Spectrum order tables 2D (1 per slitlet), PRO.CATG=ORDER2D_slitlet_IFU_arm
  • 3 Spectrum order tables 1D (1 per slitlet), PRO.CATG=ORDER1D_slitlet_IFU_arm
  • 3 Spectrum merge tables 2D (1 per slitlet), PRO.CATG=MERGE2D_slitlet_IFU_arm
  • 3 Spectrum merge tables 1D (1 per slitlet), PRO.CATG=MERGE1D_slitlet_IFU_arm
  • 1 Spectrum merge 3D, PRO.CATG=MERGE3D_IFU_arm

like, the output list alone is giving main character energy 🌈

👑 OPTIONS 👑

every single one of these has a full name in the EsoRex configuration file, and bestie I am listing all of them, 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_ifu_offset_drl.keep-temp [default = no].
  • --debug-level <str> — extra xshooter debug level, pick one of none, low, medium, high. (str; default: none). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.debug-level [default = none].
  • --time-stamp <bool> — adds a timestamp to the product file name. (bool; default: False). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.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 codes you'll actually care about: 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_ifu_offset_drl.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_ifu_offset_drl.pre-overscan-corr [default = 1].
  • --stack-method <str> — method used to build the master frame. (str; default: median). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.stack-method [default = median].
  • --klow <float> — kappa used to clip low level values, when method is set to mean. (float; default: 5.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.klow [default = 5.0].
  • --khigh <float> — kappa used to clip high level values, when method is set to mean. (float; default: 5.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.khigh [default = 5.0].
  • --crh-clip-kappa <float> — kappa value in sigma clipping during CRH rejection using multiple frames. (float; default: 5.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.crh-clip-kappa [default = 5.0].
  • --crh-clip-niter <int> — number of iterations in sigma clipping during CRH rejection using multiple frames. (int; default: 5). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.crh-clip-niter [default = 5].
  • --crh-clip-frac <float> — minimal ratio of points accepted / total in sigma clipping during CRH rejection using multiple frames. (float; default: 0.7). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.crh-clip-frac [default = 0.7].
  • --background-edges-margin <int> — X margin to order edge to define background sampling points. (int; default: 1). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.background-edges-margin [default = 1].
  • --background-poly-deg-y <int> — poly mode fit deg along Y. (int; default: 9). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.background-poly-deg-y [default = 9].
  • --background-poly-deg-x <int> — poly mode fit deg along X. (int; default: 9). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.background-poly-deg-x [default = 9].
  • --background-poly-kappa <float> — poly mode kappa value of kappa-sigma-clip outliers removal. (float; default: 10.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.background-poly-kappa [default = 10.0].
  • --removecrhsingle-sigmalim <float> — Poisson fluctuation threshold to flag CRHs (see van Dokkum, PASP,113,2001,p1420-27). (float; default: 5.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.removecrhsingle-sigmalim [default = 5.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_ifu_offset_drl.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_ifu_offset_drl.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_ifu_offset_drl.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_ifu_offset_drl.rectify-radius [default = 2.0].
  • --rectify-bin-lambda <float> — wavelength step in the output spectrum [nm]. (float; default: 0.06). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.rectify-bin-lambda [default = 0.06].
  • --rectify-bin-slit <float> — spatial step along the slit in the output spectrum [arcsec]. (float; default: 0.21). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.rectify-bin-slit [default = 0.21].
  • --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_ifu_offset_drl.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_ifu_offset_drl.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_ifu_offset_drl.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_ifu_offset_drl.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_ifu_offset_drl.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_ifu_offset_drl.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_ifu_offset_drl.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_ifu_offset_drl.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_ifu_offset_drl.localize-use-skymask [default = False].

okay that's the options wrapped 🫶 and there's more where that came from — this page is a two-parter, so keep scrolling bestie, we are not done yet 💖

  • --extract-method <str> — the method bestie, which extraction technique we're using, and your choices are LOCALIZATION or NOD (type: str, default: LOCALIZATION). ✨ The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.extract-method [default = LOCALIZATION].
  • --stdextract-interp-hsize <int> — half size of the mask used to define the object cross order profile (type: int, default: 30). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.stdextract-interp-hsize [default = 30]. 🎀
  • --shift-offsettab-low <float> — a global shift of the lower slitlet slit positions, relative to the central one, in [arcsec] (type: float, default: 0.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.shift-offsettab-low [default = 0.0]. 💅
  • --shift-offsettab-up <float> — same energy but for the upper slitlets: a global shift of the upper slitlet slit positions, relative to the central one, in [arcsec] (type: float, default: 0.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.shift-offsettab-up [default = 0.0]. 🦋
  • --compute-map <bool> — if TRUE, recompute the (wave and slit) maps from the dispersion solution. 🗺️ And heads up: if sky-subtract is set to TRUE, this one must be set to TRUE too, no exceptions (type: bool, default: True). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.compute-map [default = True].
  • --check-afc <bool> — input AFC corrected model/wave solution and science frame check. If TRUE, the recipe verifies that the input mode/wave solution is AFC corrected, that its INS.OPTIi.NAME is ´Pin_0.5 ´, and that its OBS.ID and OBS.TARG.NAME values match the corresponding values of the science frame (type: bool, default: True). ✅ The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.check-afc [default = True].
  • --flat-method <str> — the method adopted for flat (type: str, default: ´master´). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_offset_drl.flat-method [default = master]. 🌈
Note that 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_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 friend group fr fr 💖

🌟 VERSION 🌟

xsh_scired_ifu_offset_drl 3.5.3

💜 AUTHOR 💜

P.Goldoni, L.Guglielmi, R. Haigron, F. Royer <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>. 🙏

⚖️ 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 thing bestie, we made it to the end 🫶 this little love letter is xsh_scired_ifu_offset_drl version 3.5.3, dated 3.5.3, and it lives at the bottom of XSH_SCIRED_IFU_OFFSET_DRL(7) — go forth and reduce those IFU offset frames, you absolute icon 👑✨

📦 where this page comes from