xsh_mbias7
Create the master bias frame
Usage
esorex xsh_mbias [OPTIONS] FILE.sof
Overview
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 <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].
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.
Version
xsh_mbias 3.5.0
Releases
4 releases since Debian 8 (Jessie); the text changed 3 times.
--pd_noise_compute since Debian 11 (Bullseye);
--pd_noise_dc_x since Debian 11 (Bullseye);
--pd_noise_dc_y since Debian 11 (Bullseye).