XSH_RESPON_SLIT_OFFSET(7)

📦 version 3.5.3, in ubuntu jammy, ubuntu noble

💅 XSH_RESPON_SLIT_OFFSET 💅

okay bestie, welcome to XSH_RESPON_SLIT_OFFSET(7) — the xshoo recipe that does the absolute most. It computes the response function in SLIT and on/off mode, and yes, it's giving ✨*science*✨. Sit down, hydrate, we're going through it together.

🌸 NAME 🌸

xsh_respon_slit_offset — Compute the response function in SLIT and on/off mode.

🦋 SYNOPSIS 🦋

esorex xsh_respon_slit_offset [OPTIONS] FILE.sof

✨ DESCRIPTION ✨

So this recipe reduces science exposure in SLIT configuration and on/off mode. That's the vibe. Here's everything it wants and everything it hands back, no cap:

💖 Input Frames

  • A set of n Science frames ( n even ), Tag = STD_FLUX_SLIT_OFFSET_arm, SKY_SLIT_arm
  • 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] Table with dispersion coefficients (Tag = DISP_TAB_arm)
  • [OPTIONAL] A telluric model catalog (Tag = TELL_MOD_CAT_arm arm=VIS,NIR)
  • A standard star fluxes catalog (Tag = FLUX_STD_CATALOG_arm Type = FLX)
  • A table to set response sampling points (Tag = RESP_FIT_POINTS_CAT_arm)
  • An atmospheric extinction table (Tag = ATMOS_EXT_arm) — and lowkey if this is provided, this is the one used to flux calibrate the spectra 👑

🎀 Products

  • [If STD is in catal] The response ord-by-ord function (Tag = RESPONSE_ORDER1D_SLIT_arm)
  • [If STD is in catal] The response merged function (Tag = RESPONSE_MERGE1D_SLIT_arm)
  • 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
  • [If STD is in catal] Flux calibrated order-by-order 2D spectrum (Tag = PREFIX_FLUX_ORDER2D_arm)
  • [If STD is in catal] Flux calibrated order-by-order 1D spectrum (Tag = PREFIX_FLUX_ORDER1D_arm)
  • [If STD is in catal] Flux calibrated merged 2D spectrum (Tag = PREFIX_FLUX_MERGE2D_arm)
  • [If STD is in catal] Flux calibrated merged 1D spectrum (Tag = PREFIX_FLUX_MERGE1D_arm)
  • PREFIX_SKY_arm, 2D sky frame
  • SKY_SLIT_ORDER2D_arm, 2D sky image (order-by-order)
  • SKY_SLIT_MERGE2D_arm, 2D sky image (merged)
  • [If STD is in catal] The efficiency (Tag = EFFICIENCY_arm)
  • PREFIX_WAVE_MAP_arm, wave map image
  • PREFIX_SLIT_MAP_arm, slit map image
  • where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC

🌈 OPTIONS 🌈

One bullet per option, all of them, zero skips, because we don't do that here 💖

  • --keep-temp <str> — If ´no´, temporary files are deleted. (str; default: ´no´).

EsoRex config name: xsh.xsh_respon_slit_offset.keep-temp [default = no]

  • --debug-level <str> — Additional xshooter debug level. One of ´none´, ´low´, ´medium´, ´high´ (str; default: ´none´).

EsoRex config name: xsh.xsh_respon_slit_offset.debug-level [default = none]

  • --time-stamp <bool> — Add timestamp to product file name. (bool; default: False).

EsoRex config name: xsh.xsh_respon_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 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).

EsoRex config name: xsh.xsh_respon_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).

EsoRex config name: xsh.xsh_respon_slit_offset.pre-overscan-corr [default = 1]

  • --removecrhsingle-sigmalim <float> — Poisson fluctuation threshold to flag CRHs (see van Dokkum, PASP,113,2001,p1420-27) (float; default: 20.0).

EsoRex config name: xsh.xsh_respon_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).

EsoRex config name: xsh.xsh_respon_slit_offset.removecrhsingle-flim [default = 2.0]

  • --removecrhsingle-niter <int> — Max number of iterations (int; default: 4).

EsoRex config name: xsh.xsh_respon_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´).

EsoRex config name: xsh.xsh_respon_slit_offset.rectify-kernel [default = tanh]

  • --rectify-radius <float> — Rectify Interpolation radius [bin units]. (float; default: 2.0).

EsoRex config name: xsh.xsh_respon_slit_offset.rectify-radius [default = 2.0]

  • --rectify-bin-lambda <float> — Wavelength step in the output spectrum [nm] (float; default: -1.0).

EsoRex config name: xsh.xsh_respon_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).

EsoRex config name: xsh.xsh_respon_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´).

EsoRex config name: xsh.xsh_respon_slit_offset.localize-method [default = MANUAL]

  • --localize-chunk-nb <int> — Number of chunks in the full spectrum to localize the object (int; default: 10).

EsoRex config name: xsh.xsh_respon_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).

EsoRex config name: xsh.xsh_respon_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).

EsoRex config name: xsh.xsh_respon_slit_offset.localize-deg-lambda [default = 0]

  • --localize-slit-position <float> — Object position on the slit for MANUAL localization [arcsec] (float; default: 0.0).

EsoRex config name: xsh.xsh_respon_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).

EsoRex config name: xsh.xsh_respon_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).

EsoRex config name: xsh.xsh_respon_slit_offset.localize-kappa [default = 3.0]

  • --localize-niter <int> — Number of iterations for sigma clipping in the localization polynomial fit (int; default: 3).

EsoRex config name: xsh.xsh_respon_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).

EsoRex config name: xsh.xsh_respon_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).

EsoRex config name: xsh.xsh_respon_slit_offset.stdextract-interp-hsize [default = 30]

  • --combinenod-method <str> — Combination method for nodded frames (MEDIAN, MEAN) (str; default: ´MEAN´).

EsoRex config name: xsh.xsh_respon_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).

EsoRex config name: xsh.xsh_respon_slit_offset.gen-sky [default = True]

  • --correct-tellurics <bool> — TRUE if during response computation we apply telluric correction (bool; default: True).

EsoRex config name: xsh.xsh_respon_slit_offset.correct-tellurics [default = True]

🫶 heads up bestie: 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.

part 1 of 2, so don't go anywhere… 💜

✨ SEE ALSO ✨

okay bestie, you want more? say less 💅 here's where you go to keep the hyperfixation going:

  • the full documentation for the xshoo pipeline is out here as a PDF, go download it:
ftp://ftp.eso.org/pub/dfs/pipelines/xshoo/xshoo-pipeline-manual-12.1.pdf
  • wanna see the whole ESO pipelines cinematic universe? there's an overview page:
https://www.eso.org/sci/software/pipelines/
  • the basics of the EsoRex program live in the esorex(1) man page. go read it, it's giving foundational 🫶
  • and yes, you can call the pipelines from python using the python-cpl package 😌 further info here:
https://packages.python.org/python-cpl/index.html
  • also, the other recipes in the xshoo pipeline are out here living their lives: 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_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)

like. the whole squad. 🌈

🌸 VERSION 🌸

xsh_respon_slit_offset 3.5.3 — that's the one, no cap ⭐

👑 AUTHOR 👑

D. Bramich, A.Modigliani <amodigli@eso.org>

they did that. and they ate. 💖

💀 BUG REPORTS 💀

found something cursed? it happens bestie, no judgement 🙈 please report any problems to amodigli@eso.org. or, alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org> — they're the group chat that actually answers 🫶

🎀 LICENSE 🎀

so here's the legal tea, and it's important so read it fr fr:

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. (yes that's shouty, but it's shouty on purpose, that's the vibe check the lawyers insisted on 💅)

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

k that's the whole page bestie, you're officially certified in xsh_respon_slit_offset 📜✨ go slay some slit offsets 💖

and that's a wrap on xsh_respon_slit_offset version 3.5.3 — she's iconic, she's documented, she's yours. mwah 🎀💜

📦 where this page comes from