SYNOPSIS

esorex xsh_scired_ifu_stare_drl [OPTIONS] FILE.sof

DESCRIPTION

This recipe reduces science exposure in IFU configuration and stare mode Input Frames :
  - A set of n Science frames ( n == 1 or >=3, Tag = OBJECT_IFU_STARE_arm or STD_TELL_IFU_STARE_arm or STD_FLUX_IFU_STARE_arm)
  - A spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm)
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)
  - [OPTIONAL]A master dark frame (Tag = MASTER_DARK_arm)
  - A master flat frame (Tag = MASTER_FLAT_IFU_arm)
  - An AFC corrected order table frame (Tag = ORDER_TAB_AFC_IFU_arm)
  - [physmod] An AFC corrected model cfg frame (Tag = XSH_MOD_CFG_OPT_AFC_arm)
  - [poly] An AFC corrected model wavesol frame (Tag = WAVE_TAB_AFC_arm) 
  - [OPTIONAL] An AFC corrected dispersion solution frame (Tag = DISP_TAB_AFC_arm)
  - [OPTIONAL] A slit map (Tag = SLIT_MAP_arm)
  - [OPTIONAL] A badpixel map (Tag = BADPIXEL_MAP_arm)
  - [OPTIONAL] A mask of telluric lines (Tag = TELL_MASK_arm) Products :
  - 3 Spectrum order tables 2D (1 per slitlet), PRO.CATG=ORDER2D_slitlet_IFU_arm
  - 3 Spectrum merge tables 2D (1 per slitlet), PRO.CATG=MERGE2D_slitlet_IFU_arm
  - 1 Spectrum merge 3D, PRO.CATG=MERGE3D_IFU_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_scired_ifu_stare_drl.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_scired_ifu_stare_drl.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_scired_ifu_stare_drl.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_scired_ifu_stare_drl.decode-bp [default = 2144337919].

--pre-overscan-corr <long>

pre-overscan correction.0: no correction1: mean overscan correction2: mean prescan correction3: (mean pre+mean overscan)/2 correction (long; default: 1). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.pre-overscan-corr [default = 1].

--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_scired_ifu_stare_drl.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_scired_ifu_stare_drl.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_scired_ifu_stare_drl.khigh [default = 5.0].

--crh-clip-kappa <float>

Kappa value in sigma clipping during CRH rejection using multiple frames (float; default: 5.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.crh-clip-kappa [default = 5.0].

--crh-clip-niter <long>

Number of iterations in sigma clipping during CRH rejection using multiple frames (long; default: 5). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.crh-clip-niter [default = 5].

--crh-clip-frac <float>

Minimal ratio of points accepted / total in sigma clipping during CRH rejection using multiple frames (float; default: 0.7). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.crh-clip-frac [default = 0.7].

--background-edges-margin <long>

X margin to order edge to define background sampling points (long; default: 1). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.background-edges-margin [default = 1].

--background-poly-deg-y <long>

Poly mode fit deg along Y. (long; default: 9). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.background-poly-deg-y [default = 9].

--background-poly-deg-x <long>

Poly mode fit deg along X. (long; default: 9). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.background-poly-deg-x [default = 9].

--background-poly-kappa <float>

Poly mode kappa value of kappa-sigma-clip outliers removal. (float; default: 10.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.background-poly-kappa [default = 10.0].

--removecrhsingle-sigmalim <float>

Poisson fluctuation threshold to flag CRHs (see van Dokkum, PASP,113,2001,p1420-27) (float; default: 5.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.removecrhsingle-sigmalim [default = 5.0].

--removecrhsingle-flim <float>

Minimum contrast between the Laplacian image and the fine structure image that a point must have to be flagged as CRH. (see van Dokkum, PASP,113,2001,p1420-27) (float; default: 2.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.removecrhsingle-flim [default = 2.0].

--removecrhsingle-niter <long>

Max number of iterations (long; default: 4). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.removecrhsingle-niter [default = 4].

--rectify-kernel <str>

Name of the Interpolation Kernel Used. Possible values are: tanh, sinc, sinc2, lanczos, hamming, hann. (str; default: 'tanh'). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.rectify-kernel [default = tanh].

--rectify-radius <float>

Rectify Interpolation radius [bin units]. (float; default: 2.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.rectify-radius [default = 2.0].

--rectify-bin-lambda <float>

Wavelength step in the output spectrum [nm] (float; default: 0.06). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.rectify-bin-lambda [default = 0.06].

--rectify-bin-slit <float>

Spatial step along the slit in the output spectrum [arcsec] (float; default: 0.21). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.rectify-bin-slit [default = 0.21].

--localize-method <str>

Localization method (MANUAL, MAXIMUM, GAUSSIAN) used to detect the object centroid and height on the slit (str; default: 'MANUAL'). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.localize-method [default = MANUAL].

--localize-chunk-nb <long>

Number of chunks in the full spectrum to localize the object (long; default: 10). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.localize-chunk-nb [default = 10].

--localize-thresh <float>

Threshold relative to the peak intensity below which the edges of the object are detected for MAXIMUM localization (float; default: 0.1). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.localize-thresh [default = 0.1].

--localize-deg-lambda <long>

Degree in lambda in the localization polynomial expression slit=f(lambda), used only for MAXIMUM and GAUSSIAN (long; default: 0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.localize-deg-lambda [default = 0].

--localize-slit-position <float>

Object position on the slit for MANUAL localization [arcsec] (float; default: 0.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.localize-slit-position [default = 0.0].

--localize-slit-hheight <float>

Object half height on the slit for MANUAL localization [arcsec] (float; default: 2.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.localize-slit-hheight [default = 2.0].

--localize-kappa <float>

Kappa value for sigma clipping in the localization polynomial fit (float; default: 3.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.localize-kappa [default = 3.0].

--localize-niter <long>

Number of iterations for sigma clipping in the localization polynomial fit (long; default: 3). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.localize-niter [default = 3].

--localize-use-skymask <bool>

TRUE if we want to mask sky lines using SKY_LINE_LIST file. (bool; default: False). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.localize-use-skymask [default = False].

--extract-method <str>

Method used for extraction (LOCALIZATION, NOD) (str; default: 'LOCALIZATION'). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.extract-method [default = LOCALIZATION].

--stdextract-interp-hsize <long>

Half size of mask used to define object cross order profile (long; default: 30). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.stdextract-interp-hsize [default = 30].

--shift-offsettab-low <float>

Global shift of the lower slitlet slit positions, relative to the central one[arcsec]. (float; default: 0.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.shift-offsettab-low [default = 0.0].

--shift-offsettab-up <float>

Global shift of the upper slitlet slit positions, relative to the central one[arcsec]. (float; default: 0.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.shift-offsettab-up [default = 0.0].

--compute-map <bool>

if TRUE recompute (wave and slit) maps from the dispersion solution. If sky-subtract is set to TRUE this must be set to TRUE. (bool; default: True). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.compute-map [default = True].

--check-afc <bool>

Input AFC corrected model/wave solution and science frame check.If TRUE the recipe verify that the input mode/wave solution is AFC corrected, its INS.OPTIi.NAME is 'Pin_0.5 ', and its OBS.ID and OBS.TARG.NAME values matches with the corresponding values of the science frame. (bool; default: True). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.check-afc [default = True].

--flat-method <str>

method adopted for flat: (str; default: 'master'). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare_drl.flat-method [default = master].

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_scired_ifu_stare_drl 2.7.1

AUTHOR

P.Goldoni, L.Guglielmi, R. Haigron, F. Royer <[email protected]>

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