/usr/share/doc/cpl-plugin-xshoo-doc/html/_sources/xsh_mbias.txt is in cpl-plugin-xshoo-doc 2.8.4+dfsg-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | The xsh_mbias recipe
===============================================================
.. data:: xsh_mbias
Synopsis
--------
Create the master bias frame
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)
Constructor
-----------
.. method:: cpl.Recipe("xsh_mbias")
:noindex:
Create an object for the recipe xsh_mbias.
::
import cpl
xsh_mbias = cpl.Recipe("xsh_mbias")
Parameters
----------
.. py:attribute:: xsh_mbias.param.keep_temp
If 'no', temporary files are deleted. (str; default: 'no') [default="no"].
.. py:attribute:: xsh_mbias.param.debug_level
Additional xshooter debug level. One of 'none', 'low', 'medium', 'high' (str; default: 'none') [default="none"].
.. py:attribute:: xsh_mbias.param.time_stamp
Add timestamp to product file name. (bool; default: False) [default=False].
.. py:attribute:: xsh_mbias.param.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. (long; default: 2144337919) [default=2144337919].
.. py:attribute:: xsh_mbias.param.stack_method
Method used to build master frame. (str; default: 'median') [default="median"].
.. py:attribute:: xsh_mbias.param.klow
Kappa used to clip low level values, when method is set to 'mean' (float; default: 5.0) [default=5.0].
.. py:attribute:: xsh_mbias.param.khigh
Kappa used to clip high level values, when method is set to 'mean' (float; default: 5.0) [default=5.0].
.. py:attribute:: xsh_mbias.param.fpn_llx
Lower left reference area X coordinate for Fixed Pattern Noise computation (long; default: 10) [default=10].
.. py:attribute:: xsh_mbias.param.fpn_lly
Lower left reference area Y coordinate for Fixed Pattern Noise computation (long; default: 10) [default=10].
.. py:attribute:: xsh_mbias.param.fpn_urx
Upper right reference area X coordinate for Fixed Pattern Noise computation (long; default: 1024) [default=1024].
.. py:attribute:: xsh_mbias.param.fpn_ury
Upper right reference area Y coordinate for Fixed Pattern Noise computation (long; default: 1024) [default=1024].
.. py:attribute:: xsh_mbias.param.fpn_hsize
Sample size for Fixed Pattern Noise computation (long; default: 10) [default=10].
.. py:attribute:: xsh_mbias.param.fpn_nsamples
Number of sampling points for Fixed Pattern Noise computation (long; default: 100) [default=100].
.. py:attribute:: xsh_mbias.param.ron_method
RON computation method (str; default: 'ALL') [default="ALL"].
.. py:attribute:: xsh_mbias.param.random_sizex
Region X size for random computation (long; default: 10) [default=10].
.. py:attribute:: xsh_mbias.param.random_nsamples
Number of random samples (long; default: 100) [default=100].
.. py:attribute:: xsh_mbias.param.ref1_llx
Lower left X of reference region (long; default: -1) [default=-1].
.. py:attribute:: xsh_mbias.param.ref1_lly
Lower left Y of reference region (long; default: -1) [default=-1].
.. py:attribute:: xsh_mbias.param.ref1_urx
Upper right X of reference region (long; default: -1) [default=-1].
.. py:attribute:: xsh_mbias.param.ref1_ury
Upper right Y of reference region (long; default: -1) [default=-1].
.. py:attribute:: xsh_mbias.param.ref2_llx
Lower left X of reference region (long; default: -1) [default=-1].
.. py:attribute:: xsh_mbias.param.ref2_lly
Lower left Y of reference region (long; default: -1) [default=-1].
.. py:attribute:: xsh_mbias.param.ref2_urx
Upper right X of reference region (long; default: -1) [default=-1].
.. py:attribute:: xsh_mbias.param.ref2_ury
Upper right Y of reference region (long; default: -1) [default=-1].
.. py:attribute:: xsh_mbias.param.stacking_ks_low
Lower value of kappa-sigma clip in stacking (long; default: 3) [default=3].
.. py:attribute:: xsh_mbias.param.stacking_ks_iter
Number of iterations in kappa-sigma clip in stacking (long; default: 25) [default=25].
.. py:attribute:: xsh_mbias.param.struct_refx
Reference X value to compute structure (long; default: -1) [default=-1].
.. py:attribute:: xsh_mbias.param.struct_refy
Reference Y value to compute structure (long; default: -1) [default=-1].
The following code snippet shows the default settings for the available
parameters.
::
import cpl
xsh_mbias = cpl.Recipe("xsh_mbias")
xsh_mbias.param.keep_temp = "no"
xsh_mbias.param.debug_level = "none"
xsh_mbias.param.time_stamp = False
xsh_mbias.param.decode_bp = 2144337919
xsh_mbias.param.stack_method = "median"
xsh_mbias.param.klow = 5.0
xsh_mbias.param.khigh = 5.0
xsh_mbias.param.fpn_llx = 10
xsh_mbias.param.fpn_lly = 10
xsh_mbias.param.fpn_urx = 1024
xsh_mbias.param.fpn_ury = 1024
xsh_mbias.param.fpn_hsize = 10
xsh_mbias.param.fpn_nsamples = 100
xsh_mbias.param.ron_method = "ALL"
xsh_mbias.param.random_sizex = 10
xsh_mbias.param.random_nsamples = 100
xsh_mbias.param.ref1_llx = -1
xsh_mbias.param.ref1_lly = -1
xsh_mbias.param.ref1_urx = -1
xsh_mbias.param.ref1_ury = -1
xsh_mbias.param.ref2_llx = -1
xsh_mbias.param.ref2_lly = -1
xsh_mbias.param.ref2_urx = -1
xsh_mbias.param.ref2_ury = -1
xsh_mbias.param.stacking_ks_low = 3
xsh_mbias.param.stacking_ks_iter = 25
xsh_mbias.param.struct_refx = -1
xsh_mbias.param.struct_refy = -1
You may also set or overwrite some or all parameters by the recipe
parameter `param`, as shown in the following example:
::
import cpl
xsh_mbias = cpl.Recipe("xsh_mbias")
[...]
res = xsh_mbias( ..., param = {"keep_temp":"no", "debug_level":"none"})
.. seealso:: `cpl.Recipe <http://packages.python.org/python-cpl/recipe.html>`_
for more information about the recipe object.
Bug reports
-----------
Please report any problems to `P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani <amodigli@eso.org>`_. Alternatively, you may
send a report to the `ESO User Support Department <usd-help@eso.org>`_.
Copyright
---------
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
.. codeauthor:: P.Goldoni, L.Guglielmi, R. Haigron, F. Royer, D. Bramich, A. Modigliani <amodigli@eso.org>
|