Provided by: cpl-plugin-uves-doc_6.1.6+dfsg-1build1_all 
NAME
flames_obs_scired - Reduces a FLAMES science image
SYNOPSIS
esorex flames_obs_scired [OPTIONS] FILE.sof
DESCRIPTION
Fibre & order position determination procedure: You should feed the recipe with: - science
fibre images (FIB_SCI_RED, FIB_SCI_SIM_RED, FIB_SCI_SIM_RED) - single fibre images,
FIB_ORDEF_(REDL|REDU) - master bias frames, MASTER_BIAS_(REDL|REDU) - Fibre order table,
FIB_ORDEF_TABLE_(REDL|REDU) - Slit flatfield common, SLIT_FF_COM_(REDL|REDU) - Slit
flatfield norm, SLIT_FF_NOR_(REDL|REDU) - Slit flatfield data, SLIT_FF_DTC_(REDL|REDU) -
Slit flatfield sigma, SLIT_FF_SGC_(REDL|REDU) - Slit flatfield bad pixel,
SLIT_FF_BPC_(REDL|REDU) - Slit flatfield boundary, SLIT_FF_BNC_(REDL|REDU) - Fibre
flatfield common, FIB_FF_COM_(REDL|REDU) - Fibre flatfield norm, FIB_FF_NOR_(REDL|REDU) -
Fibre flatfield norm sigma, FIB_FF_NSG_(REDL|REDU)
Products are: - Science fibre info table (FIB_SCI_INFO_TAB) - XB_SCI_RAW_(REDL|REDU) -
ERR_XB_SCI_RAW_(REDL|REDU) - WXB_SCI_RAW_(REDL|REDU) - ERR_WXB_SCI_RAW_(REDL|REDU) -
MWXB_SCI_RAW_(REDL|REDU) - ERR_MWXB_SCI_RAW_(REDL|REDU) - XB_SCI_(REDL|REDU) -
ERR_XB_SCI_(REDL|REDU) - WXB_SCI_(REDL|REDU) - ERR_WXB_SCI_(REDL|REDU) -
MWXB_SCI_(REDL|REDU) - ERR_MWXB_SCI_(REDL|REDU)
OPTIONS
--bias_method <str>
Bias subtraction method (str; default: ´M´). The full name of this option for the
EsoRex configuration file is flames_obs_scired.bias_method [default = M].
--bias_value <int>
Bias value (only if bias_method = V) (int; default: 200). The full name of this
option for the EsoRex configuration file is flames_obs_scired.bias_value [default =
200].
--bkg_max_io_win <int>
Background window number in each full inter order (int; default: 500). The full
name of this option for the EsoRex configuration file is
flames_obs_scired.bkg_max_io_win [default = 500].
--bkg_xy_win_sz_x <int>
x maximum size of each background window: (int; default: 6). The full name of this
option for the EsoRex configuration file is flames_obs_scired.bkg_xy_win_sz_x
[default = 6].
--bkg_xy_win_sz_y <int>
y maximum size of each background window: (int; default: 2). The full name of this
option for the EsoRex configuration file is flames_obs_scired.bkg_xy_win_sz_y
[default = 2].
--clean_tmp_products <bool>
Input data format (bool; default: False). The full name of this option for the
EsoRex configuration file is flames_obs_scired.clean_tmp_products [default =
False].
--cor_def_off <float>
Correlation center offset? (float; default: 0.0). The full name of this option for
the EsoRex configuration file is flames_obs_scired.cor_def_off [default = 0.0].
--cor_def_pnt <int>
Correlation sampling points? (int; default: 25). The full name of this option for
the EsoRex configuration file is flames_obs_scired.cor_def_pnt [default = 25].
--cor_def_rng <float>
Correlation range size? (float; default: 6.0). The full name of this option for the
EsoRex configuration file is flames_obs_scired.cor_def_rng [default = 6.0].
--cor_max_fnd <str>
Find correlation maximum? (str; default: ´Y´). The full name of this option for the
EsoRex configuration file is flames_obs_scired.cor_max_fnd [default = Y].
--corvel_iter <int>
Velocity correlation iteration number (SimCal) (int; default: 1). The full name of
this option for the EsoRex configuration file is flames_obs_scired.corvel_iter
[default = 1].
--cubify_sw <str>
Cubify switch (str; default: ´N´). The full name of this option for the EsoRex
configuration file is flames_obs_scired.cubify_sw [default = N].
--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].
--drs_base_name <str>
Base name for science products (str; default: ´fxb´). The full name of this option
for the EsoRex configuration file is flames_obs_scired.drs_base_name [default =
fxb].
--drs_ext_w_siz <float>
Integration window size good: 10 (if fibre deconvolution works fine) (float;
default: 10.0). The full name of this option for the EsoRex configuration file is
flames_obs_scired.drs_ext_w_siz [default = 10.0].
--drs_k_s_thre <float>
Kappa sigma threshold (float; default: 10.0). The full name of this option for the
EsoRex configuration file is flames_obs_scired.drs_k_s_thre [default = 10.0].
--drs_maxyshift <float>
Half width of the interval to scan for correlation, when determining y shift
(float; default: 3.0). The full name of this option for the EsoRex configuration
file is flames_obs_scired.drs_maxyshift [default = 3.0].
--ext_method <str>
Extraction method (str; default: ´opt´). The full name of this option for the
EsoRex configuration file is flames_obs_scired.ext_method [default = opt].
--filt_sw <str>
Filter switch (str; default: ´none´). The full name of this option for the EsoRex
configuration file is flames_obs_scired.filt_sw [default = none].
--merge <str>
Order merging method. If ´optimal´, the flux in the overlapping region is set to
the (optimally computed, using the uncertainties) average of single order spectra.
If ´sum´, the flux in the overlapping region is computed as the sum of the single
order spectra. If flat-fielding is done, method ´optimal´ is recommended, otherwise
´sum´. (str; default: ´optimal´). The full name of this option for the EsoRex
configuration file is flames_obs_scired.merge [default = optimal].
--merge_delt1 <float>
Order merging left hand (short wavelength) cut. To reduce the amount of order
overlapping regions we allow to cut short and long wavelength ranges. This may
reduce the ripple possibly introduced by the order merging. Suggested values are:
10 (W<=390), 12 (390<W<=437, 520<W<=564), 14 (437<W<=520, 564<W<860), 4 (W>=860)
(float; default: -1.0). The full name of this option for the EsoRex configuration
file is flames_obs_scired.merge_delt1 [default = -1.0].
--merge_delt2 <float>
Order merging right hand (long wavelength) cut. To reduce the amount of order
overlapping regions we allow to cut short and long wavelength ranges. This may
reduce the ripple possibly introduced by the order merging. Suggested values is 4
for W<860, else 0 (float; default: -1.0). The full name of this option for the
EsoRex configuration file is flames_obs_scired.merge_delt2 [default = -1.0].
--pixel_thresh_max <int>
Pixel saturation threshold max (int; default: 55000). The full name of this option
for the EsoRex configuration file is flames_obs_scired.pixel_thresh_max [default =
55000].
--pixel_thresh_min <int>
Pixel saturation threshold min (int; default: -20). The full name of this option
for the EsoRex configuration file is flames_obs_scired.pixel_thresh_min [default =
-20].
--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].
--rebin.scale <bool>
Whether or not to multiply by the factor dx/dlambda (pixels per wavelength) during
the rebinning to conserve the flux. This option is disabled as default because
applying the flat field correction already ensures flux conservation. Therefore
this parameter should be TRUE (for response and science data) only if
reduce.ffmethd = no. (bool; default: False). The full name of this option for the
EsoRex configuration file is flames_obs_scired.rebin.scale [default = False].
--rebin.wavestep <float>
The bin size used for BLUE/REDL data (in w.l.u.) in wavelength space. If negative,
a step size of 2/3 * ( average pixel size ) is used. (float; default: -1.0). The
full name of this option for the EsoRex configuration file is
flames_obs_scired.rebin.wavestep [default = -1.0].
--rebin.wavestep_redu <float>
The bin size used for REDU data (in w.l.u.) in wavelength space. If negative, a
step size of 2/3 * ( average pixel size ) is used. (float; default: -1.0). The full
name of this option for the EsoRex configuration file is
flames_obs_scired.rebin.wavestep_redu [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.
SEE ALSO
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-6.1.6.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 uves pipeline are flames_cal_mkmaster(7), flames_cal_orderpos(7),
flames_cal_predict(7), flames_cal_prep_sff_ofpos(7), flames_cal_wavecal(7),
flames_obs_redchain(7), flames_utl_unpack(7), uves_cal_cd_align(7), uves_cal_mbias(7),
uves_cal_mdark(7), uves_cal_mflat(7), uves_cal_mflat_combine(7), uves_cal_mkmaster(7),
uves_cal_orderpos(7), uves_cal_predict(7), uves_cal_response(7), uves_cal_tflat(7),
uves_cal_wavecal(7), uves_obs_redchain(7), uves_obs_scired(7), uves_utl_ima_arith(7),
uves_utl_remove_crh_single(7)
VERSION
flames_obs_scired 6.1.6
AUTHOR
Andrea Modigliani <cpl@eso.org>
BUG REPORTS
Please report any problems to cpl@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 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