--- name: "xsh_mbias" section: "7" platform: "linux" package: "cpl-plugin-xshoo-doc" version: "3.5.0+dfsg-4" release: "Debian 11 (Bullseye)" platforms: ["linux"] url: "https://new.carta.tech/xsh_mbias" --- # xsh\_mbias(7) Create the master bias frame ## NAME xsh\_mbias - Create the master bias frame ## SYNOPSIS esorex **xsh\_mbias** \[OPTIONS\] FILE.sof ## DESCRIPTION This recipe creates a master bias frame by computing the median of all input bias frames. 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** *\* If ´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** *\* Additional 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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*\]. 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_2dmap/7.md), [*xsh\_cfg\_recover*(7)](/xsh_cfg_recover/7.md), [*xsh\_flexcomp*(7)](/xsh_flexcomp/7.md), [*xsh\_geom\_ifu*(7)](/xsh_geom_ifu/7.md), [*xsh\_lingain*(7)](/xsh_lingain/7.md), [*xsh\_mdark*(7)](/xsh_mdark/7.md), [*xsh\_mflat*(7)](/xsh_mflat/7.md), [*xsh\_orderpos*(7)](/xsh_orderpos/7.md), [*xsh\_predict*(7)](/xsh_predict/7.md), [*xsh\_respon\_slit\_nod*(7)](/xsh_respon_slit_nod/7.md), [*xsh\_respon\_slit\_offset*(7)](/xsh_respon_slit_offset/7.md), [*xsh\_respon\_slit\_stare*(7)](/xsh_respon_slit_stare/7.md), [*xsh\_scired\_ifu\_offset*(7)](/xsh_scired_ifu_offset/7.md), [*xsh\_scired\_ifu\_offset\_drl*(7)](/xsh_scired_ifu_offset_drl/7.md), [*xsh\_scired\_ifu\_stare*(7)](/xsh_scired_ifu_stare/7.md), [*xsh\_scired\_ifu\_stare\_drl*(7)](/xsh_scired_ifu_stare_drl/7.md), [*xsh\_scired\_slit\_nod*(7)](/xsh_scired_slit_nod/7.md), [*xsh\_scired\_slit\_offset*(7)](/xsh_scired_slit_offset/7.md), [*xsh\_scired\_slit\_stare*(7)](/xsh_scired_slit_stare/7.md), [*xsh\_util\_physmod*(7)](/xsh_util_physmod/7.md), [*xsh\_wavecal*(7)](/xsh_wavecal/7.md) ## VERSION xsh\_mbias 3.5.0 ## AUTHOR P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani \ ## BUG REPORTS Please report any problems to amodigli@eso.org. Alternatively, you may send a report to the ESO User Support Department \. ## 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