Man pages sections > man7 > xsh_mbias

xsh_mbias - Create the master bias frame

XSH_MBIAS(7) xshoo recipes XSH_MBIAS(7)

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 <str>
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 <str>
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 <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 <long>
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. (long; 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 <long>
Lower left reference area X coordinate for Fixed Pattern Noise computation (long; default: 10). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_llx [default = 10].
--fpn_lly <long>
Lower left reference area Y coordinate for Fixed Pattern Noise computation (long; default: 10). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_lly [default = 10].
--fpn_urx <long>
Upper right reference area X coordinate for Fixed Pattern Noise computation (long; default: 1024). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_urx [default = 1024].
--fpn_ury <long>
Upper right reference area Y coordinate for Fixed Pattern Noise computation (long; default: 1024). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_ury [default = 1024].
--fpn_hsize <long>
Sample size for Fixed Pattern Noise computation (long; default: 10). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.fpn_hsize [default = 10].
--fpn_nsamples <long>
Number of sampling points for Fixed Pattern Noise computation (long; 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 <long>
Region X size for random computation (long; default: 10). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.random_sizex [default = 10].
--random_nsamples <long>
Number of random samples (long; default: 100). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.random_nsamples [default = 100].
--ref1_llx <long>
Lower left X of reference region (long; default: -1). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref1_llx [default = -1].
--ref1_lly <long>
Lower left Y of reference region (long; default: -1). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref1_lly [default = -1].
--ref1_urx <long>
Upper right X of reference region (long; default: -1). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref1_urx [default = -1].
--ref1_ury <long>
Upper right Y of reference region (long; default: -1). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref1_ury [default = -1].
--ref2_llx <long>
Lower left X of reference region (long; default: -1). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref2_llx [default = -1].
--ref2_lly <long>
Lower left Y of reference region (long; default: -1). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref2_lly [default = -1].
--ref2_urx <long>
Upper right X of reference region (long; default: -1). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref2_urx [default = -1].
--ref2_ury <long>
Upper right Y of reference region (long; default: -1). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.ref2_ury [default = -1].
--stacking_ks_low <long>
Lower value of kappa-sigma clip in stacking (long; 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 <long>
Number of iterations in kappa-sigma clip in stacking (long; default: 25). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.stacking_ks_iter [default = 25].
--struct_refx <long>
Reference X value to compute structure (long; default: -1). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.struct_refx [default = -1].
--struct_refy <long>
Reference Y value to compute structure (long; default: -1). The full name of this option for the EsoRex configuration file is xsh.xsh_mbias.struct_refy [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 http://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 http://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)
 

VERSION

xsh_mbias 2.9.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>.
 

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
2.9.3 xsh_mbias