VISIR_OLD_SPC_WCAL_ECH(7)

📦
version 4.4.2 · 2 versions
, in debian bookworm, ubuntu noble

💖 VISIR_OLD_SPC_WCAL_ECH 💖

okay bestie, welcome to section 7 of the manuals — the visir recipes corner of the universe — where we meet visir_old_spc_wcal_ech, aka the Old DRS detector's Spectroscopic wavelength calibration recipe in Echelle mode. she's giving very niche, very powerful, very wavelength. let's get into it ✨

🎀 SYNOPSIS 🎀

esorex visir_old_spc_wcal_ech [OPTIONS] FILE.sof

that's it, that's the summoning ritual 💅

🌸 DESCRIPTION 🌸

so what does she actually do? this recipe estimates the dispersion relation using the atmospheric spectrum in a grism spectroscopy half-cycle frame. atmospheric lines are literally her best friend, no cap 🌈

the files listed in the Set Of Frames (sof-file) must be tagged like this:

VISIR-Echelle-Spectroscopy-file.fits SPEC_CAL_HRG_WCAL
VISIR-Quantum-Efficiency-Calibration-file.fits SPEC_CAL_QEFF
VISIR-Atmospheric-Emission-Lines-Calibration-file.fits SPEC_CAL_LINES

and bonus round: a bad pixel map with a PRO.CATG of SPEC_BPM may be added to the Set Of Frames with the tag BPM. optional but she'll happily accept it 🫶

✨ OPTIONS ✨

  • --auto_bpm <bool> — automatic detection and correction of bad pixels. it's a bool, and the default is True. the full name of this option for the EsoRex configuration file is visir.visir_old_spc_wcal_ech.auto_bpm [default = True]. she's automatic, she's correcting, she's that girl 💅
  • --plot <int> — okay this one is a whole saga, sit down 🍓. the recipe can produce a number of predefined plots. zero means none of the plots are produced, while increasing values (e.g. 1 or 2) increase the number of plots produced. if the plotting fails a warning is produced, and the recipe continues (she does not crash out, she's resilient). the default behaviour of the plotting is to use gnuplot (with option -persist). the recipe currently produces 1D-plots using gnuplot commands. the recipe user can control the actual plotting-command used by the recipe to create the plot by setting the environment variable CPL_PLOTTER. currently, if CPL_PLOTTER is set it must contain the string ´gnuplot´. setting it to ´cat > my_gnuplot_$$.txt´ causes a number of ASCII-files to be created, which each produce a plot when given as standard input to gnuplot (e.g. later or on a different computer). a finer control of the plotting options can be obtained by writing an executable script, e.g. my_gnuplot.pl, that executes gnuplot after setting the desired gnuplot options (e.g. set terminal pslatex color) and then setting CPL_PLOTTER to my_gnuplot.pl. the predefined plots include plotting of images. images can be plotted not only with gnuplot, but also using the pnm format. this is controlled with the environment variable CPL_IMAGER. if CPL_IMAGER is set to a string that does not contain the word gnuplot, the recipe will generate the plot in pnm format. e.g. setting CPL_IMAGER to ´display - &´ will produce a gray-scale image using the image viewer display. it's an int; default: 0. the full name of this option for the EsoRex configuration file is visir.visir_old_spc_wcal_ech.plot [default = 0]. obsessed with the flexibility honestly 😭
  • --slit_skew <float> — distortion correction: skew of slit (degrees) (clockwise). it's a float; default: 0.0. the full name of this option for the EsoRex configuration file is visir.visir_old_spc_wcal_ech.phi [default = 0.0]. yes the option name and the config name are different, that's just her vibe 🙈
  • --spectrum_skew <float> — distortion correction: LMR skew of spectrum (degrees) (counter-clockwise). not used in High Resolution. float; default: 0.0. the full name of this option for the EsoRex configuration file is visir.visir_old_spc_wcal_ech.ksi [default = 0.0].
  • --vert_arc <float> — distortion correction: LR detector vertical curvature (pixel). reduced by a factor 4 in MR. not used in HR A-side. increased by a factor 115/52 in HR B-side. float; default: 0.0. the full name of this option for the EsoRex configuration file is visir.visir_old_spc_wcal_ech.eps [default = 0.0]. math is math bestie 🔥
  • --hori_arc <float> — distortion correction: LMR detector horizontal curvature (pixel). increased by a factor 1.5 in HR A-side. reduced by a factor 2 in HR B-side. float; default: 0.0. the full name of this option for the EsoRex configuration file is visir.visir_old_spc_wcal_ech.delta [default = 0.0].
  • --orderoffset <int> — Echelle order offset. the offset is relative to the main order. the allowed range of offsets depend on the selected grism. the offset can never exceed +/-4. if the main order is e.g. 8 an order offset of +1 will cause the recipe to base the data reduction on order 9. with a positive order offset the central wavelength becomes smaller, while for a negative order offset the central wavelength becomes larger. int; default: 0. the full name of this option for the EsoRex configuration file is visir.visir_old_spc_wcal_ech.orderoffset [default = 0]. shifting orders like a main character 👑
  • --rl <int> — reject leftmost columns in spectrum extraction, zero means all columns on the left are used. in cross-dispersion mode a (small) negative number may be used (pixel). int; default: 0. the full name of this option for the EsoRex configuration file is visir.visir_old_spc_wcal_ech.reject_left [default = 0].
  • --rr <int> — reject rightmost columns in spectrum extraction, zero means all columns on the right are used. in cross-dispersion mode a (small) negative number may be used (pixel). int; default: 0. the full name of this option for the EsoRex configuration file is visir.visir_old_spc_wcal_ech.reject_right [default = 0].
ngl, 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 visir pipeline can be downloaded as a PDF file using the following URL:

ftp://ftp.eso.org/pub/dfs/pipelines/visir/visir-pipeline-manual-1.4.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 visir pipeline are visir_img_dark(7), visir_img_ff(7), visir_img_reduce(7), visir_img_trans(7), visir_old_img_combine(7), visir_old_img_phot(7), visir_old_spc_obs(7), visir_old_spc_obs_ech(7), visir_old_spc_phot(7), visir_old_spc_phot_ech(7), visir_old_spc_wcal(7), visir_old_util_destripe(7), visir_spc_reduce(7), visir_util_apply_calib(7), visir_util_clip(7), visir_util_convert_weight(7), visir_util_detect_shift(7), visir_util_img_std_cat(7), visir_util_join(7), visir_util_qc(7), visir_util_repack(7), visir_util_run_swarp(7), visir_util_spc_std_cat(7), visir_util_spc_txt2fits(7), visir_util_undistort(7). the whole friend group, fr fr 🫶

💫 VERSION 💫

visir_old_spc_wcal_ech 4.4.2

🌈 AUTHOR 🌈

Lars Lundin <https://support.eso.org> — icon behavior, honestly ⭐

💀 BUG REPORTS 💀

please report any problems to https://support.eso.org. alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>. (not me telling you to file your bugs, but like, do it 🙈)

👑 LICENSE 👑

this file is part of the VISIR Instrument Pipeline Copyright (C) 2004, 2005 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., 51 Franklin St, Fifth Floor, Boston, MA 02111-1307 USA.

and that's the whole page, bestie 💖 this was visir_old_spc_wcal_ech, version 4.4.2, living her best life in the VISIR_OLD_SPC_WCAL_ECH(7) manual — wavelength calibration in Echelle, atmospheric spectrum edition. slay, calibrate, periodt ✨🎀

📦 where this page comes from