XSH_SCIRED_IFU_STARE(7)

📦 version 3.5.3, in ubuntu jammy, ubuntu noble

XSH_SCIRED_IFU_STARE(7) 💖

okay bestie, listen — this is a page from the xshoo recipes manual set, and it's all about the xsh_scired_ifu_stare recipe. it's giving ✨cosmic data wrangling✨ and we're gonna get through it together.

✨ NAME ✨

xsh_scired_ifu_stare — reduce science IFU stare exposures and build a 3D cube 🧊💅

🌸 SYNOPSIS 🌸

esorex xsh_scired_ifu_stare [OPTIONS] FILE.sof

🦋 DESCRIPTION 🦋

so this recipe takes your science IFU stare exposures and reduces them, and on top of that it builds you a whole 3D cube. main character energy, honestly.

Input Frames 🫶

  • a set of n Science frames (n == 1 or >=3, Tag = OBJECT_IFU_STARE_UVB)
  • a spectral format table frame (Tag = SPECTRAL_FORMAT_TAB_arm)
  • [UVB,VIS] a master bias frame (Tag = MASTER_BIAS_arm)
  • a master dark frame (Tag = MASTER_DARK_arm)
  • a master flat frame (Tag = MASTER_FLAT_IFU_arm)
  • an order edges table frame (Tag = ORDER_TAB_EDGES_IFU_arm)
  • [physmod] an AFC corrected model cfg frame (Tag = XSH_MOD_CFG_OPT_AFC_arm)
  • [poly] an AFC corrected model wavesol frame (Tag = WAVE_TAB_AFC_arm)
  • [OPTIONAL] a non-linear badpixel map (Tag = BP_MAP_NL_arm)
  • [OPTIONAL] a reference badpixel map (Tag = BP_MAP_RP_arm)

Products 👑

  • merged 3D data cube (PREFIX_MERGE3D_DATA_OBJ_arm)
  • QC Traces of 3D data cube (PREFIX_MERGE3D_TRACE_OBJ_arm)
  • order by order 3D data cube (PREFIX_ORDER3D_DATA_OBJ_arm)
  • order by order 3D qual cube (IFU_CFG_COR_arm)
  • order by order 3D qual cube (PREFIX_MERGE3D_DATA_SKY_arm)
  • and where PREFIX is SCI, FLUX, TELL if the input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC

💅 OPTIONS 💅

  • --keep-temp <str> — if it's set to no, those temporary files get deleted, no hoarding 🗑️. (str; default: no). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare.keep-temp [default = no].
  • --debug-level <str> — extra xshooter debug level, bestie. 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_stare.debug-level [default = none].
  • --time-stamp <bool> — stamps a timestamp onto the product file name 🕰️ (bool; default: False). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare.time-stamp [default = False].
  • --decode-bp <int> — the integer representation of the bits that count as bad when you're decoding the bad pixel mask pixel values. the codes the user actually runs into most: 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_stare.decode-bp [default = 2144337919].
  • --pre-overscan-corr <int> — pre-overscan correction, choose your fighter: 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_stare.pre-overscan-corr [default = 1].
  • --stack-method <str> — the 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_stare.stack-method [default = median].
  • --klow <float> — the kappa used to clip low level values, when the 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_stare.klow [default = 5.0].
  • --khigh <float> — the kappa used to clip high level values, when the 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_stare.khigh [default = 5.0].
  • --crh-clip-kappa <float> — the 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_stare.crh-clip-kappa [default = 5.0].
  • --crh-clip-niter <int> — how many iterations of 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_stare.crh-clip-niter [default = 5].
  • --crh-clip-frac <float> — the 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_stare.crh-clip-frac [default = 0.7].
  • --background-edges-margin <int> — X margin to order edge, used to define background sampling points (int; default: 1). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare.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_stare.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_stare.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_stare.background-poly-kappa [default = 10.0].
  • --rectify-kernel <str> — the 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_stare.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_stare.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_ifu_stare.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_ifu_stare.rectify-bin-slit [default = -1.0].
  • --compute-map <bool> — if TRUE, recompute the (wave and slit) maps from the dispersion solution. heads up bestie: if sky-subtract is set to TRUE this must be set to TRUE too 🚨 (bool; default: False). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare.compute-map [default = False].
  • --trace-obj <bool> — if TRUE, trace object position on each IFU slice. in that case order TAB edges is required (bool; default: False). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare.trace-obj [default = False].
  • --check-afc <bool> — Input AFC corrected model/wave solution and science frame check. if TRUE the recipe verify that the input mode/wave solution is AFC corrected, its INS.OPTIi.NAME is Pin_0.5 , and its OBS.ID and OBS.TARG.NAME values matches with the corresponding values of the science frame (bool; default: True). the full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare.check-afc [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_ifu_stare.cut-uvb-spectrum [default = True].
ngl you can absolutely make a configuration file holding all these options with their nice default values 💖 just go check the deets that 'esorex --help' gives you.

🌈 SEE ALSO 🌈

the full documentation for the xshoo pipeline can be downloaded as a PDF file using this URL, fr fr:

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

an overview over the existing ESO pipelines lives on this web page: https://www.eso.org/sci/software/pipelines/.

basic documentation about the EsoRex program is in the esorex (1) man page.

and yesss, you can call the pipelines from python using the python-cpl package. see https://packages.python.org/python-cpl/index.html for more ✨

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_drl(7), xsh_scired_slit_nod(7), xsh_scired_slit_offset(7), xsh_scired_slit_stare(7), xsh_util_physmod(7), xsh_wavecal(7) 🫶

⭐ VERSION ⭐

xsh_scired_ifu_stare 3.5.3

🎀 AUTHOR 🎀

A.Modigliani, J.Vernet, P. Bristow <Andrea.Modigliani@eso.org>

💀 BUG REPORTS 💀

please report any problems to Andrea.Modigliani@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 page bestie, we ate and left no crumbs 💅✨ this was xsh_scired_ifu_stare version 3.5.3 from the xshoo recipes manual set — love that for us 🦋💖

📦 where this page comes from