VISIR_OLD_IMG_PHOT(7)

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

💖 VISIR_OLD_IMG_PHOT(7) 💖

okay bestie, welcome to the visir recipes section, and specifically to visir_old_img_phot — the Old DRS detector: Sensitivity computation era. this is giving vintage but make it ✨science✨.

✨ NAME ✨

visir_old_img_phot — Old DRS detector: Sensitivity computation 🎀

🌸 SYNOPSIS 🌸

esorex visir_old_img_phot [OPTIONS] FILE.sof

like literally that's the whole vibe, bestie. one command, one sof file, endless possibilities 💅

🦋 DESCRIPTION 🦋

so what does this recipe do? it computes the conversion factor and the sensitivity of a standard star. it needs a standard star catalog to even function — no catalog, no slay 🙈.

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

VISIR-std-star-observation.fits IM_CAL_PHOT
VISIR-Imaging-Standard-Star-Catalog.fits IMG_STD_CATALOG

the primary product is gonna have a FITS card ´HIERARCH ESO PRO CATG´ with a string value of ´IMG_PHOT_COMBINED´ — periodt. and the corresponding beam-collapsed product gets a FITS card ´HIERARCH ESO PRO CATG´ with a value of IMG_PHOT_ONEBEAM 👑

also (bonus round ✨) a bad pixel map with a PRO.CATG of IMG_BPM may be added to the Set Of Frames, tagged as BPM.

💅 OPTIONS 💅

no fr, here's every single one. don't skip, bestie, they all matter 🫶

  • --nod <str> — an optional ASCII specification of the nodding positions, for when they're just missing from the FITS-file (rude of them tbh). the file must have one line per input FITS-file, and each line must have an integer (which gets ignored, don't stress) followed by a 0 or 1 to indicate object or sky. (str; default: ´NONE´). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.nodding [default = NONE].
  • --auto_bpm <bool> — automatic detection and correction of bad pixels. yes, it does the pixel cleanup for you, main character energy 🔥 (bool; default: True). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.auto_bpm [default = True].
  • --g <bool> — automatic filtering of glitches. bye bye glitchy nonsense ✨ (bool; default: False). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.rem_glitch [default = False].
  • --p <bool> — automatic purging of half-cycle images whose median deviates more than a factor three from the mean of the medians of half-cycle images, or whose standard deviation deviates more than a factor three from the mean of their standard deviations. dramatic? yes. necessary? also yes 💀 (bool; default: False). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.purge_bad [default = False].
  • --union <bool> — combine images using their union, as opposed to their intersection. > heads up bestie: this one is deprecated and ignored, see --combine_method instead. we love a legacy flag that's just vibing there 🙈 (bool; default: True). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.union [default = True].
  • --rej <str> — each resulting pixel is the average of the corresponding (interpolated) pixel value in each jittered image. a positive value, n1, for the first of the two integers means that for each pixel, the smallest n1 pixel values shall be ignored in the averaging. similarly, a positive value, n2, for the second of the two integers means that for each pixel, the largest n2 pixel values shall be ignored in the averaging. (str; default: ´0-0´). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.rej [default = 0-0].
  • --plot <int> — 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 just... continues, no big deal 💁‍♀️. 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. (int; default: 0). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.plot [default = 0].
  • --off <str> — an optional ASCII specification of the offsets, for when the ones in FITS-headers are missing or just plain wrong 😭. the file must have one line per input pair of FITS-files, and each line must have two numbers representing the shift in pixels of that image relative to the first image. the first line should thus comprise two zeros. correct FITS-header offsets mean that the i´th X offset can be gotten from Xoffset_0 - Xoffset_i, where Xoffset_i is the value of ESO SEQ CUMOFFSETX and likewise for Y. (str; default: ´NONE´). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.offsets [default = NONE].
  • --ref <bool> — user-defined refining of the image offsets. see options objs and xcorr. (bool; default: False). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.refine [default = False].
  • --objs <str> — the shift and add of images needs anchor points, which are typically bright objects. these are normally detected automatically, but with user-defined refining of offsets enabled, they must be provided by the user through an ASCII file containing one line per anchor point, with each line consisting of its x and y coordinate (in pixels). this file is ignored with user-defined refining of offsets disabled. (str; default: ´NONE´). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.objects [default = NONE].
  • --xcorr <str> — if user-defined refining of offsets is enabled, a cross-correlation of the images is performed. in order to speed up this process, this cross-correlation is performed only on smaller rectangles around the anchor points. the first two parameters are the half-size of this rectangle in pixels. the second pair is the maximum shift in x and y (pixels) evaluated by the cross-correlation on the rectangle. used only if user-defined refining of offsets is enabled. (str; default: ´10-10-25-25´). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.xcorr [default = 10-10-25-25].
  • --jy_val <float> — the flux of the standard star in Jansky 🌟 (float; default: -999.0). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.jy_val [default = -999.0].
  • --radii <str> — radii : star_max bg_int bg_ext. that's the whole lineup, bestie 🎀 (str; default: ´20-20-30´). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.radii [default = 20-20-30].
  • --combine_method <str> — combine images using one of: 1) Onto the first image (first); 2) Their union (union); 3) Their intersection (inter). NB: only the ´first´-method produces an image product with WCS coordinates. a successful ´first´-method always produces a combined image with dimensions equal to those of the input images. for the ´union´-method the result image is at least as large as the input images, while for the ´inter´-method the result image is at most as large as the input images. (str; default: ´union´). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.comb_meth [default = union].
  • --destripe_iterations <int> — max number of destriping iterations (0 to disable destriping). horizontal destriping is done first, and if no horizontal striping is detected, vertical destriping is performed. stripes? not on our watch 💅 (int; default: 15). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.nstripe [default = 15].
  • --destripe_morpho <bool> — destripe with morphological cleaning ✨ (bool; default: False). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.mstripe [default = False].
  • --eccmax <float> — the maximum eccentricity allowed in the combination of the three (in parallel nod/chopping) or four (in perpendicular nod/chopping) beams. in parallel mode, three perfectly aligned points spaced with the chopnod throw will have eccentricity 0, while in perpedicular mode a square with the chopnod throw as the side length will have eccentricity 0. geometry class but make it ✨recipe options✨ (float; default: 0.25). the full name of this option for the EsoRex configuration file is visir.visir_old_img_phot.eccmax [default = 0.25].
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. go check it, bestie, it's giving helpful 🫶

💖 SEE ALSO 💖

okay so you've read the whole page and you still want MORE?? obsessed. say less, bestie 🫶

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/. go browse, it's giving ✨ options ✨.

Basic documentation about the EsoRex program can be found at the esorex (1) man page. (yes, it has its own manpage, iconic behaviour.)

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. python girlies, this one's for you 🐍💅

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_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_spc_wcal_ech(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)

like... the whole friend group fr fr 🌈

🎀 VERSION 🎀

visir_old_img_phot 4.4.2

that's the one, that's the girl 💅

👑 AUTHOR 👑

Lars Lundin <https://support.eso.org>

ty for your service king 🫡

💀 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>.

bestie if something's broken, TELL THEM 😭 don't just sit there suffering in silence, the support team literally exists for this. no cap.

📜 LICENSE 📜

This file is part of the VISIR Instrument Pipeline Copyright (C) 2004, 2005 European Southern Observatory

okay legal era, let's get into it 💜

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.

literally no warranty, bestie. it's giving "use at your own risk" and I mean that with love 🙈

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 a wrap on the whole page, we did it 🎉🌸

so this was visir_old_img_phot version 4.4.2, living in the VISIR_OLD_IMG_PHOT(7) manpage section, and honestly? she ate. now go reduce some images and slay ✨🦋💖

📦 where this page comes from