.TH XSH_ORDERPOS "7" "3.5.0" "xsh_orderpos" "xshoo recipes" .SH NAME xsh_orderpos \- Create the orders centre traces table file .SH SYNOPSIS esorex .B xsh_orderpos [OPTIONS] FILE.sof .SH DESCRIPTION This recipe creates the orders centre traces table. .PP Input Frames for UVB and VIS: Raw file (Tag = ORDERDEF_arm_D2) Master Dark (Tag = MASTER_DARK_arm) Master Bias (Tag = MASTER_BIAS_arm) Input Frames for NIR: Raw file ON(Tag = ORDERDEF_NIR_ON) Raw file OFF(Tag = ORDERDEF_NIR_OFF) Input Frames for all arms Guess order table (Tag = ORDER_TAB_GUESS_arm) Spectral format table (Tag = SPECTRAL_FORMAT_TAB_arm) \- [OPTIONAL] A map of non linear bad pixels (Format=QUP, Tag = BP_MAP_NL_arm) \- [OPTIONAL] A map of reference bad pixels (Format = QUP,RAW, Tag = BP_MAP_RP_arm) Prepare PRE structures. .PP For NIR, subtract NIR\-OFF from NIR\-ON. .PP For UVB and NIR, Substract the master Bias and master dark. .PP Detect Orders and calculate the order table. .PP The final products are: An updated Order Table, PRO.CATG=ORDER_TABLE_CENTR_arm. .PP A order trace residuals Table, PRO.CATG=ORDERPOS_RESID_TAB_arm. .PP The order pos frame bias subtracted, PRO.CATG=ORDERDEF_ON_arm. .PP .SH OPTIONS .TP \fB\-\-keep\-temp\fR \fI\fR If \'no\', temporary files are deleted. (str; default: \'no\'). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.keep\-temp\fR [default = \fIno\fR]. .TP \fB\-\-debug\-level\fR \fI\fR 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 \fBxsh.xsh_orderpos.debug\-level\fR [default = \fInone\fR]. .TP \fB\-\-time\-stamp\fR \fI\fR Add timestamp to product file name. (bool; default: False). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.time\-stamp\fR [default = \fIFalse\fR]. .TP \fB\-\-decode\-bp\fR \fI\fR 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 \fBxsh.xsh_orderpos.decode\-bp\fR [default = \fI2144337919\fR]. .TP \fB\-\-pre\-overscan\-corr\fR \fI\fR 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 \fBxsh.xsh_orderpos.pre\-overscan\-corr\fR [default = \fI1\fR]. .TP \fB\-\-detectcontinuum\-search\-win\-hsize\fR \fI\fR Half window size in pixels for the 1D box to search for the maximum in the cross\-dispersion profile (int; default: 5). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.detectcontinuum\-search\-win\-hsize\fR [default = \fI5\fR]. .TP \fB\-\-detectcontinuum\-running\-win\-hsize\fR \fI\fR Half window size for the running median box during the search for the maximum in the cross\-dispersion profile (int; default: 0). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.detectcontinuum\-running\-win\-hsize\fR [default = \fI0\fR]. .TP \fB\-\-detectcontinuum\-fit\-win\-hsize\fR \fI\fR Half window size for the fit of the cross\-dispersion profile (int; default: 5). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.detectcontinuum\-fit\-win\-hsize\fR [default = \fI5\fR]. .TP \fB\-\-detectcontinuum\-center\-thresh\-fac\fR \fI\fR Threshold factor applied to check that the flux at the fitted peak is higher than error. (float; default: 0.0). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.detectcontinuum\-center\-thresh\-fac\fR [default = \fI0.0\fR]. .TP \fB\-\-detectcontinuum\-ordertab\-step\-y\fR \fI\fR Step in Y for order centroid detection (int; default: 1). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.detectcontinuum\-ordertab\-step\-y\fR [default = \fI1\fR]. .TP \fB\-\-detectcontinuum\-ordertab\-deg\-y\fR \fI\fR Degree in Y in the polynomial order tracing X=f(Y) (int; default: 5). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.detectcontinuum\-ordertab\-deg\-y\fR [default = \fI5\fR]. .TP \fB\-\-detectcontinuum\-clip\-res\-max\fR \fI\fR Maximum allowed residual (before kappa\-sigma clip) (float; default: 0.5). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.detectcontinuum\-clip\-res\-max\fR [default = \fI0.5\fR]. .TP \fB\-\-detectcontinuum\-clip\-sigma\fR \fI\fR Kappa value in sigma clipping during order trace polynomial fit (float; default: 5.0). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.detectcontinuum\-clip\-sigma\fR [default = \fI5.0\fR]. .TP \fB\-\-detectcontinuum\-clip\-niter\fR \fI\fR Number of iterations in sigma clipping during order trace polynomial fit (int; default: 5). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.detectcontinuum\-clip\-niter\fR [default = \fI5\fR]. .TP \fB\-\-detectcontinuum\-clip\-frac\fR \fI\fR Minimal fractions of points accepted / total in sigma clippingduring order trace polynomial fit (float; default: 0.4). The full name of this option for the EsoRex configuration file is \fBxsh.xsh_orderpos.detectcontinuum\-clip\-frac\fR [default = \fI0.4\fR]. .PP 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. .SH SEE ALSO The full documentation for the xshoo pipeline can be downloaded as a PDF file using the following URL: .IP .B ftp://ftp.eso.org/pub/dfs/pipelines/xshoo/xshoo\-pipeline\-manual\-12.1.pdf .PP An overview over the existing ESO pipelines can be found on the web page \fBhttps://www.eso.org/sci/software/pipelines/\fR. .PP Basic documentation about the EsoRex program can be found at the esorex (1) man page. .PP It is possible to call the pipelines from python using the python\-cpl package. See \fBhttps://packages.python.org/python\-cpl/index.html\fR for further information. .PP The other recipes of the xshoo pipeline are .IR xsh_2dmap (7), .IR xsh_cfg_recover (7), .IR xsh_flexcomp (7), .IR xsh_geom_ifu (7), .IR xsh_lingain (7), .IR xsh_mbias (7), .IR xsh_mdark (7), .IR xsh_mflat (7), .IR xsh_predict (7), .IR xsh_respon_slit_nod (7), .IR xsh_respon_slit_offset (7), .IR xsh_respon_slit_stare (7), .IR xsh_scired_ifu_offset (7), .IR xsh_scired_ifu_offset_drl (7), .IR xsh_scired_ifu_stare (7), .IR xsh_scired_ifu_stare_drl (7), .IR xsh_scired_slit_nod (7), .IR xsh_scired_slit_offset (7), .IR xsh_scired_slit_stare (7), .IR xsh_util_physmod (7), .IR xsh_wavecal (7) .SH VERSION xsh_orderpos 3.5.0 .SH AUTHOR L.Guglielmi,R.Haigron,P.Goldoni,F.Royer, A. Modigliani .SH BUG REPORTS Please report any problems to amodigli@eso.org. Alternatively, you may send a report to the ESO User Support Department . .SH 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