--- name: "xsh_scired_ifu_stare" section: "7" platform: "linux" package: "cpl-plugin-xshoo-doc" version: "3.5.0+dfsg-4" release: "Debian 11 (Bullseye)" platforms: ["linux"] url: "https://new.carta.tech/xsh_scired_ifu_stare" --- # xsh\_scired\_ifu\_stare(7) Reduce science IFU stare exposures and build a 3D cube ## NAME xsh\_scired\_ifu\_stare - Reduce science IFU stare exposures and build a 3D cube ## 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** *\* 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** *\* 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** *\* 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** *\* 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. (int; 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** *\* pre-overscan correction. 0: no correction 1: mean overscan correction 2: mean prescan correction 3: (mean pre+mean overscan)/2 correction (int; 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* Number of iterations in sigma clipping during CRH rejection using multiple frames (int; 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** *\* 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** *\* X margin to order edge to define background sampling points (int; 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** *\* Poly mode fit deg along Y. (int; 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** *\* Poly mode fit deg along X. (int; 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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. ## SEE ALSO The full documentation for the xshoo pipeline can be downloaded as a PDF file using the following URL: - **ftp://ftp.eso.org/pub/dfs/pipelines/xshoo/xshoo-pipeline-manual-12.1.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 xshoo pipeline are [*xsh\_2dmap*(7)](/xsh_2dmap/7.md), [*xsh\_cfg\_recover*(7)](/xsh_cfg_recover/7.md), [*xsh\_flexcomp*(7)](/xsh_flexcomp/7.md), [*xsh\_geom\_ifu*(7)](/xsh_geom_ifu/7.md), [*xsh\_lingain*(7)](/xsh_lingain/7.md), [*xsh\_mbias*(7)](/xsh_mbias/7.md), [*xsh\_mdark*(7)](/xsh_mdark/7.md), [*xsh\_mflat*(7)](/xsh_mflat/7.md), [*xsh\_orderpos*(7)](/xsh_orderpos/7.md), [*xsh\_predict*(7)](/xsh_predict/7.md), [*xsh\_respon\_slit\_nod*(7)](/xsh_respon_slit_nod/7.md), [*xsh\_respon\_slit\_offset*(7)](/xsh_respon_slit_offset/7.md), [*xsh\_respon\_slit\_stare*(7)](/xsh_respon_slit_stare/7.md), [*xsh\_scired\_ifu\_offset*(7)](/xsh_scired_ifu_offset/7.md), [*xsh\_scired\_ifu\_offset\_drl*(7)](/xsh_scired_ifu_offset_drl/7.md), [*xsh\_scired\_ifu\_stare\_drl*(7)](/xsh_scired_ifu_stare_drl/7.md), [*xsh\_scired\_slit\_nod*(7)](/xsh_scired_slit_nod/7.md), [*xsh\_scired\_slit\_offset*(7)](/xsh_scired_slit_offset/7.md), [*xsh\_scired\_slit\_stare*(7)](/xsh_scired_slit_stare/7.md), [*xsh\_util\_physmod*(7)](/xsh_util_physmod/7.md), [*xsh\_wavecal*(7)](/xsh_wavecal/7.md) ## VERSION xsh\_scired\_ifu\_stare 3.5.0 ## AUTHOR A.Modigliani, J.Vernet, P. Bristow \ ## BUG REPORTS Please report any problems to Andrea.Modigliani@eso.org. Alternatively, you may send a report to the ESO User Support Department \. ## 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