SYNOPSIS

esorex xsh_scired_ifu_stare [OPTIONS] FILE.sof

DESCRIPTION

This recipe reduce science IFU stare exposures with 3D cube generation Input Frames :
  - A set of n Science frames ( n == 1 or >=3,     Tag = OBJECT_IFU_STARE_UVB)
  - A spectral format table frame (Tag = SPECTRAL_FORMAT_TAB_arm)
  - [UVB,VIS] A master bias frame (Tag = MASTER_BIAS_arm)
  - A master dark frame (Tag = MASTER_DARK_arm)
  - A master flat frame (Tag = MASTER_FLAT_IFU_arm)
  - An order edges table frame(Tag = ORDER_TAB_EDGES_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] A non-linear badpixel map (Tag = BP_MAP_NL_arm)
  - [OPTIONAL] A reference badpixel map (Tag = BP_MAP_RP_arm) Products :
 - Merged 3D data cube (PREFIX_MERGE3D_DATA_OBJ_arm)
 - QC Traces of 3D data cube (PREFIX_MERGE3D_TRACE_OBJ_arm)
 - Order by order 3D data cube (PREFIX_ORDER3D_DATA_OBJ_arm)
 - Order by order 3D qual cube (IFU_CFG_COR_arm)
 - Order by order 3D qual cube (PREFIX_MERGE3D_DATA_SKY_arm)
 - where PREFIX is SCI, FLUX, TELL if input raw DPR.TYPE contains OBJECT or FLUX or TELLURIC

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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.background-poly-kappa [default = 10.0].

--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.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.rectify-radius [default = 2.0].

--rectify-bin-lambda <float>

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

--rectify-bin-slit <float>

Spatial step along the slit in the output spectrum [arcsec] (float; default: -1.0). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare.rectify-bin-slit [default = -1.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: False). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare.compute-map [default = False].

--trace-obj <bool>

if TRUE trace object position on each IFU slice. In this case order TAB edges is required (bool; default: False). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare.trace-obj [default = False].

--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.check-afc [default = True].

--cut-uvb-spectrum <bool>

TRUE if recipe cuts the UVB spectrum at 556 nm (dichroich) (bool; default: True). The full name of this option for the EsoRex configuration file is xsh.xsh_scired_ifu_stare.cut-uvb-spectrum [default = True].

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 2.7.1

AUTHOR

A.Modigliani, J.Vernet, P. Bristow <[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