XSH_MBIAS(7)

📦 version 3.5.3, in ubuntu jammy, ubuntu noble

💖 XSH_MBIAS 💖

okay bestie, welcome to the xsh_mbias manual page — that's a section 7 page from the xshoo recipes crew, and honestly? it's giving glow-up energy. this is the one that makes your master bias frame. let's go 🎀

✨ NAME ✨

xsh_mbias — Create the master bias frame 💅

🌸 SYNOPSIS 🌸

esorex xsh_mbias [OPTIONS] FILE.sof

🦋 DESCRIPTION 🦋

So here's the tea: this recipe creates a master bias frame by computing the median of all input bias frames. like, it just takes everything you threw at it and finds the middle child. iconic behavior, no cap.

Input Frames :

  • A set of n RAW frames (Format=RAW, n >=3, Tag = BIAS_arm)
  • [OPTIONAL] A map of non linear bad pixels (Format=QUP, Tag = BP_MAP_NL_arm)
  • [OPTIONAL] A map of reference bad pixels (Format = QUP,RAW, Tag = BP_MAP_RP_arm)

Products :

  • A master bias frame (Format=PRE, PRO.CATG = MASTER_BIAS_arm)

💖 OPTIONS 💖

  • --keep-temp <str> — if it's ´no´, temporary files are deleted. (str; default: ´no´). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.keep-temp [default = no].
  • --debug-level <str> — extra 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_mbias.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_mbias.time-stamp [default = False].
  • --decode-bp <int> — integer representation of the bits to be considered bad when decoding the bad pixel mask pixel values. 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). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.decode-bp [default = 2144337919].
  • --stack-method <str> — method used to build master frame. (str; default: ´median´). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.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_mbias.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_mbias.khigh [default = 5.0].
  • --fpn_llx <int> — lower left reference area X coordinate for Fixed Pattern Noise computation (int; default: 10). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_llx [default = 10].
  • --fpn_lly <int> — lower left reference area Y coordinate for Fixed Pattern Noise computation (int; default: 10). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_lly [default = 10].
  • --fpn_urx <int> — upper right reference area X coordinate for Fixed Pattern Noise computation (int; default: 1024). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_urx [default = 1024].
  • --fpn_ury <int> — upper right reference area Y coordinate for Fixed Pattern Noise computation (int; default: 1024). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_ury [default = 1024].
  • --fpn_hsize <int> — sample size for Fixed Pattern Noise computation (int; default: 10). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_hsize [default = 10].
  • --fpn_nsamples <int> — number of sampling points for Fixed Pattern Noise computation (int; default: 100). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_nsamples [default = 100].
  • --ron_method <str> — RON computation method (str; default: ´ALL´). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ron_method [default = ALL].
  • --random_sizex <int> — region X size for random computation (int; default: 10). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.random_sizex [default = 10].
  • --random_nsamples <int> — number of random samples (int; default: 100). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.random_nsamples [default = 100].
  • --ref1_llx <int> — lower left X of reference region (int; default: -1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref1_llx [default = -1].
  • --ref1_lly <int> — lower left Y of reference region (int; default: -1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref1_lly [default = -1].
  • --ref1_urx <int> — upper right X of reference region (int; default: -1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref1_urx [default = -1].
  • --ref1_ury <int> — upper right Y of reference region (int; default: -1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref1_ury [default = -1].
  • --ref2_llx <int> — lower left X of reference region (int; default: -1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref2_llx [default = -1].
  • --ref2_lly <int> — lower left Y of reference region (int; default: -1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref2_lly [default = -1].
  • --ref2_urx <int> — upper right X of reference region (int; default: -1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref2_urx [default = -1].
  • --ref2_ury <int> — upper right Y of reference region (int; default: -1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref2_ury [default = -1].
  • --stacking_ks_low <int> — lower value of kappa-sigma clip in stacking (int; default: 3). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.stacking_ks_low [default = 3].
  • --stacking_ks_iter <int> — number of iterations in kappa-sigma clip in stacking (int; default: 25). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.stacking_ks_iter [default = 25].
  • --struct_refx <int> — reference X value to compute structure (int; default: -1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.struct_refx [default = -1].
  • --struct_refy <int> — reference Y value to compute structure (int; default: -1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.struct_refy [default = -1].
  • --pd_noise_compute <bool> — determine Fixed Pattern Noise. if TRUE the Fixed Pattern Noise power spectrum is determined. (bool; default: False). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.pd_noise_compute [default = False].
  • --pd_noise_dc_x <int> — x-size (pixel) of the mask starting at (x,y) = (1,1). (int; default: 1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.pd_noise_dc_x [default = 1].
  • --pd_noise_dc_y <int> — y-size (pixel) of the mask starting at (x,y) = (1,1). (int; default: 1). the full name of this option for the EsoRex configuration file is xsh.xsh_mbias.pd_noise_dc_y [default = 1].
bestie, quick PSA: 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_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_offset(7), xsh_scired_slit_stare(7), xsh_util_physmod(7), xsh_wavecal(7) — the whole squad fr fr 👑

🌟 VERSION 🌟

xsh_mbias 3.5.3

👑 AUTHOR 👑

P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani <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>. they're literally there for you, bestie 🫶

💀 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 a wrap!! this was xsh_mbias version 3.5.3, served fresh from the xshoo recipes section of the manual. stay slaying, stay calibrated, and go make yourself a gorgeous master bias frame 💖✨🧚‍♀️

📦 where this page comes from