Man pages sections > man7 > xsh_wavecal

xsh_wavecal - Compute arclines tilt and instrument resolution

XSH_WAVECAL(7) xshoo recipes XSH_WAVECAL(7)

NAME

xsh_wavecal - Compute arclines tilt and instrument resolution
 

SYNOPSIS

esorex xsh_wavecal [OPTIONS] FILE.sof
 

DESCRIPTION

This recipe detects and follow arc lines in a fully illuminated slit frame.
Input Frames:
Raw frame (Tag = ARC_SLIT_arm)
Arc Line List (Tag = ARC_LINE_LIST_arm)
Master Bias (Tag = MASTER_BIAS_arm)
[OPTIONAL] Master Dark (Tag = MASTER_DARK_arm)
Order Table (Tag = ORDER_TABLE_EDGES_arm)
[poly mode] Wave Solution (Tag = WAVE_TAB_2D_arm)
[poly mode] Theoretical Map (Tag = THEO_TAB_spec_arm, spec=SING/IFU)
[physical model mode] Model cfg tab (Tag = XSH_MOD_CFG_TAB_arm)
- [OPTIONAL] A non-linear badpixel map (Tag = BP_MAP_NL_arm)
- [OPTIONAL] A reference badpixel map (Tag = BP_MAP_RP_arm)
[OPTIONAL-To compute spectral resolution] Dispersion Table Frame (Tag = DISP_TAB_arm) Prepare PRE structures.
Subtract the master Dark (UVB, VIS and NIR) (xsh_subtract_dark) Substract the master Bias (UVB and VIS)(amodigli@pc014007$ vi xsh_wavecal_fail.sofxsh_substract_bias) Divide by Flat.
Detect and follow arc lines.
Products:
Wavelength solution, PRO.CATG = WAVE_TAB_ARC_SLIT_arm [if poly mode]
Linetilt list, PRO.CATG = TILT_TAB_SLIT_arm
Residuals table, PRO.CATG = RESID_TAB_GOOD_LINES_arm
Wave Map, PRO.CATG = WAVE_MAP_arm [if model-wavemap-compute=TRUE]
In case of IFU mode cdata previous producs repat for each IFU slices
Arc frame, Bias subtracted in PRE format, PRO.CATG = ARC_BIAS_SUBTRACT_arm
If arm=UVB/VIS and PRO.CATG=ARC_NIR_ON if arm=NIR
Arc frame, Bias subtracted, FLAT-FIELDED, PRO.CATG = WAVECAL_FLATFIELDED_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_wavecal.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_wavecal.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_wavecal.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_wavecal.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_wavecal.pre-overscan-corr [default = 1].
--followarclines-search-window-half-size <long>
Half window size (HWS) in pixels (Y axis) of search window for each line. (long; default: 6). The full name of this option for the EsoRex configuration file is xsh.xsh_wavecal.followarclines-search-window-half-size [default = 6].
--followarclines-order-edges-mask <long>
Nb of pixels suppressed (X) from edges of search window. (long; default: 3). The full name of this option for the EsoRex configuration file is xsh.xsh_wavecal.followarclines-order-edges-mask [default = 3].
--followarclines-min-sn <float>
Minimum Signal over Noise ratio at center to keep the line (6 for IFU, 15 for SLIT). (float; default: -1.0). The full name of this option for the EsoRex configuration file is xsh.xsh_wavecal.followarclines-min-sn [default = -1.0].
--tilt-clip-kappa <float>
Multiple of sigma in sigma clipping for evaluate tilt (float; default: 2.5). The full name of this option for the EsoRex configuration file is xsh.xsh_wavecal.tilt-clip-kappa [default = 2.5].
--tilt-clip-niter <long>
Number of iterations in sigma clipping for evaluate tilt (long; default: 5). The full name of this option for the EsoRex configuration file is xsh.xsh_wavecal.tilt-clip-niter [default = 5].
--tilt-clip-frac <float>
Minimal fractions of points accepted / total in sigma clipping for evaluate tilt (float; default: 0.7). The full name of this option for the EsoRex configuration file is xsh.xsh_wavecal.tilt-clip-frac [default = 0.7].
--specres-clip-kappa <float>
Multiple of sigma in sigma clipping for evaluate spectral resolution (float; default: 2.5). The full name of this option for the EsoRex configuration file is xsh.xsh_wavecal.specres-clip-kappa [default = 2.5].
--specres-clip-niter <long>
Number of iterations in sigma clipping for evaluate spectral resolution (long; default: 5). The full name of this option for the EsoRex configuration file is xsh.xsh_wavecal.specres-clip-niter [default = 5].
--specres-clip-frac <float>
Minimal fractions of points accepted / total in sigma clipping for evaluate spectral resolution (float; default: 0.7). The full name of this option for the EsoRex configuration file is xsh.xsh_wavecal.specres-clip-frac [default = 0.7].
 
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 http://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 http://packages.python.org/python-cpl/index.html for further information.
The other recipes of the xshoo pipeline are xsh_2dmap(7), xsh_cfg_recover(7), xsh_flexcomp(7), xsh_geom_ifu(7), xsh_lingain(7), xsh_mbias(7), xsh_mdark(7), xsh_mflat(7), xsh_orderpos(7), xsh_predict(7), xsh_respon_slit_nod(7), xsh_respon_slit_offset(7), xsh_respon_slit_stare(7), xsh_scired_ifu_offset(7), xsh_scired_ifu_offset_drl(7), xsh_scired_ifu_stare(7), xsh_scired_ifu_stare_drl(7), xsh_scired_slit_nod(7), xsh_scired_slit_offset(7), xsh_scired_slit_stare(7), xsh_util_physmod(7)
 

VERSION

xsh_wavecal 2.9.3
 

AUTHOR

L.Guglielmi <amodigli@eso.org>
 

BUG REPORTS

Please report any problems to amodigli@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 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
2.9.3 xsh_wavecal