Creates the master bias/dark/flat frame
esorex uves_cal_mkmaster [OPTIONS] FILE.sof
This recipe calls uves_cal_mbias if any raw BIAS frame is provided otherwise uves_cal_mdark if any raw DARK frame is provided, otherwise it calls uves_cal_mflat Pls refer to those recipes for more details
--stack_method <str>
Method used to build master frame (str; default: \'median\'). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.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 uves_cal_mkmaster.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 uves_cal_mkmaster.khigh [default = 5.0].
--niter <long>
Number of kappa sigma iterations, when method is set to \'mean\' (long; default: 5). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.niter [default = 5].
--debug <bool>
Whether or not to save intermediate results to local directory (bool; default: False). The full name of this option for the EsoRex configuration file is uves.debug [default = False].
--plotter <str>
Any plots produced by the recipe are redirected to the command specified by this parameter. The plotting command must contain the substring \'gnuplot\' and must be able to parse gnuplot syntax on its standard input. Valid examples of such a command may include \'gnuplot -persist\' and \'cat > mygnuplot$$.gp\'. A finer control of the plotting options can be obtained by writing an executable script, e.g. my_gnuplot.pl, that executes gnuplot after setting the desired gnuplot options (e.g. set terminal pslatex color). To turn off plotting, set this parameter to \'no\' (str; default: \'no\'). The full name of this option for the EsoRex configuration file is uves.plotter [default = no].
--process_chip <str>
For RED arm data process the redl, redu, or both chip(s) (str; default: \'both\'). The full name of this option for the EsoRex configuration file is uves.process_chip [default = both].
--stack_method <str>
Method used to build master frame (str; default: \'median\'). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.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 uves_cal_mkmaster.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 uves_cal_mkmaster.khigh [default = 5.0].
--niter <long>
Number of kappa sigma iterations, when method is set to \'mean\' (long; default: 5). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.niter [default = 5].
--debug <bool>
Whether or not to save intermediate results to local directory (bool; default: False). The full name of this option for the EsoRex configuration file is uves.debug [default = False].
--plotter <str>
Any plots produced by the recipe are redirected to the command specified by this parameter. The plotting command must contain the substring \'gnuplot\' and must be able to parse gnuplot syntax on its standard input. Valid examples of such a command may include \'gnuplot -persist\' and \'cat > mygnuplot$$.gp\'. A finer control of the plotting options can be obtained by writing an executable script, e.g. my_gnuplot.pl, that executes gnuplot after setting the desired gnuplot options (e.g. set terminal pslatex color). To turn off plotting, set this parameter to \'no\' (str; default: \'no\'). The full name of this option for the EsoRex configuration file is uves.plotter [default = no].
--process_chip <str>
For RED arm data process the redl, redu, or both chip(s) (str; default: \'both\'). The full name of this option for the EsoRex configuration file is uves.process_chip [default = both].
--clean_traps <bool>
Clean detector traps. If TRUE detector traps are interpolated.The bad pixels are replaced by the average of nearest good pixels in the same column, or simply marked as bad. The positions of bad pixels are hard- coded (as function of UVES chip). (bool; default: True). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.clean_traps [default = True].
--norm_method <str>
Method used to build master frame (str; default: \'explevel\'). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.norm_method [default = explevel].
--qc_dark.reg.num_x <long>
Number of regions along the X axis (where mean/med/rms are computed). (long; default: 4). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.qc_dark.reg.num_x [default = 4].
--qc_dark.reg.num_y <long>
Number of regions along the Y axis(where mean/med/rms are computed). (long; default: 4). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.qc_dark.reg.num_y [default = 4].
--qc_dark.reg.box_sx <long>
Region X size [pix] (long; default: 100). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.qc_dark.reg.box_sx [default = 100].
--qc_dark.reg.box_sy <long>
Region Y size [pix] (long; default: 100). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.qc_dark.reg.box_sy [default = 100].
--qc_dark.reg.border_x <long>
X distance between the left hand side of the detector and the left hand side of the region [pix] (long; default: 100). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.qc_dark.reg.border_x [default = 100].
--qc_dark.reg.border_y <long>
X distance between the left hand side of the detector and the left hand side of the region [pix] (long; default: 100). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.qc_dark.reg.border_y [default = 100].
--qc_dark.reg.when <long>
When QC analysis is performed. 0: on each raw frame or 1: on the master frame (long; default: 0). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.qc_dark.reg.when [default = 0].
--backsub.mmethod <str>
Background measuring method. If equal to \'median\' the background is sampled using the median of a subwindow. If \'minimum\', the subwindow minimum value is used. If \'no\', no background subtraction is done. (str; default: \'median\'). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.mmethod [default = median].
--backsub.npoints <long>
This is the number of columns in interorder space used to sample the background. (long; default: 82). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.npoints [default = 82].
--backsub.radiusy <long>
The height (in pixels) of the background sampling window is (2*radiusy + 1). This parameter is not corrected for binning. (long; default: 2). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.radiusy [default = 2].
--backsub.sdegree <long>
Degree of interpolating splines. Currently only degree = 1 is supported (long; default: 1). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.sdegree [default = 1].
--backsub.smoothx <float>
If spline interpolation is used to measure the background, the x-radius of the post-smoothing window is (smoothx * image_width). Here, \'image_width\' is the image width after binning. If negative, the default values are used: (25.0/4096) for blue flat-field frames, (50.0/4096) for red flat-field frames, (300.0/4096) for blue science frames and (300.0/4096) for red science frames. (float; default: -1.0). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.smoothx [default = -1.0].
--backsub.smoothy <float>
If spline interpolation is used to measure the background, the y-radius of the post-smoothing window is (smoothy * image_height). Here, \'image_height\' is the image height after binning. If negative, the default values are used: (100.0/2048) for blue flat-field frames, (300.0/2048) for red flat-field frames, (200.0/2048) for blue science frames and (500.0/2048) for red science frames. (float; default: -1.0). The full name of this option for the EsoRex configuration file is uves_cal_mkmaster.backsub.smoothy [default = -1.0].
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.
The full documentation for the uves pipeline can be downloaded as a PDF file using the following URL:
ftp://ftp.eso.org/pub/dfs/pipelines/uves/uves-pipeline-manual-5.4.3.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 uves pipeline are uves_cal_response(7), uves_cal_mflat_combine(7), flames_utl_unpack(7), flames_cal_wavecal(7), flames_obs_redchain(7), uves_cal_wavecal(7), uves_cal_tflat(7), uves_cal_mflat(7), flames_cal_prep_sff_ofpos(7), uves_utl_remove_crh_single(7), uves_obs_scired(7), uves_cal_mbias(7), uves_utl_ima_arith(7), flames_obs_scired(7), uves_cal_orderpos(7), flames_cal_mkmaster(7), flames_cal_predict(7), uves_cal_mdark(7), uves_cal_cd_align(7), uves_obs_redchain(7), flames_cal_orderpos(7), uves_cal_predict(7)
uves_cal_mkmaster 5.4.3
Jonas M. Larsen <[email protected]>
Please report any problems to [email protected]. Alternatively, you may send a report to the ESO User Support Department <[email protected]>.
This file is part of the FLAMES/UVES Pipeline Copyright (C) 2004, 2005, 2006, 2007 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., 51 Franklin St, Fifth Floor, Boston, MA 02111-1307 USA