VISIR_IMG_REDUCE(7)

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

💖 VISIR_IMG_REDUCE 💖

okay bestie, buckle up, because visir_img_reduce is the recipe and she is lowkey doing a LOT. this is the visir recipes manual, section 7, and it's giving main character energy fr fr.

✨ NAME ✨

visir_img_reduce — combines a stack of chopped, jittered and/or nodded exposures and can compute the sensitivity for standard star observations 🫶

🌸 SYNOPSIS 🌸

esorex visir_img_reduce [OPTIONS] FILE.sof

🦋 DESCRIPTION 🦋

so basically this recipe recombines the data you observed in chopping/nodding mode, or chopping mode, or nodding mode, into one single combined image. and yes, it can optionally use cross-correlation methods to do it. iconic behaviour honestly. 💅

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

  • VISIR-observation-file.fits IM_OBS_CHO_NOD_JIT
  • VISIR-observation-file.fits IM_OBS_CHO_JIT
  • VISIR-observation-file.fits IM_OBS_NOD_JIT
  • VISIR-observation-file.fits IM_OBS_DIR_JIT
  • VISIR-observation-file.fits BURST
  • VISIR-Standard-star-catalog IMG_STD_CATALOG (optional)
  • VISIR-linearty-table.fits LINEARITY_TABLE (optional)

and also!! a bad pixel map with a PRO.CATG of IMG_BPM may be added to the Set Of Frames with the tag: BPM.

👑 OPTIONS 👑

  • --planestart <int> — plane number to start repacking from in each nod cycle. earlier planes are skipped, we don't need them. (int; default: 0). the full name of this option for the EsoRex configuration file is visir.visir_util_repack.planestart [default = 0].
  • --planelimit <int> — limits the number of processed input planes. it will repack until at least this number of input images have been processed, or until the full dataset has been repacked. ⚠️ always full chop cycles need to be repacked, so the number gets adjusted upward to the next multiple of images per chop cycle. <= 0 means no limit. (int; default: -1). the full name of this option for the EsoRex configuration file is visir.visir_util_repack.planelimit [default = -1].
  • --trimlow <int> — burst data only, bestie. number of additional planes to cut from before each plane with chopper movement. (int; default: 0). the full name of this option for the EsoRex configuration file is visir.visir_util_repack.trimlow [default = 0].
  • --trimhigh <int> — burst data only again. number of additional planes to cut from after each plane with chopper movement. a value of -1 does not skip the plane of the movement. (int; default: 0). the full name of this option for the EsoRex configuration file is visir.visir_util_repack.trimhigh [default = 0].
  • --lincorrect <bool> — apply linearity correction. 🚨 should only be enabled on high flux observations, it may degrade results otherwise. (bool; default: False). the full name of this option for the EsoRex configuration file is visir.visir_util_repack.lincorrect [default = False].
  • --template <str> — correlation template used to detect shifts and reject bad images. if none given, an averaged image is used. (str; default: ´NONE´). the full name of this option for the EsoRex configuration file is visir.visir_util_detect_shift.template [default = NONE].
  • --min-correlation <float> — minimal correlation to the template required to be accepted. (float; default: 0.5). the full name of this option for the EsoRex configuration file is visir.visir_util_detect_shift.min-correlation [default = 0.5].
  • --max-shift <float> — maximal allowed object shift for an image to be accepted. (float; default: 10.0). the full name of this option for the EsoRex configuration file is visir.visir_util_detect_shift.max-shift [default = 10.0].
  • --max-mad <float> — maximal allowed median absolute deviation for an image to be accepted. <= 0 equals no limit. (float; default: 0.0). the full name of this option for the EsoRex configuration file is visir.visir_util_detect_shift.max-mad [default = 0.0].
  • --naverage <int> — number of planes to average before attempting to detect the shifts. (int; default: 1). the full name of this option for the EsoRex configuration file is visir.visir_util_detect_shift.naverage [default = 1].
  • --method <str> — method to determine beam shifts. xcorrelate: use the cross correlation shift. brightest: use the position of the brightest pixel. (str; default: ´xcorrelate´). the full name of this option for the EsoRex configuration file is visir.visir_util_detect_shift.method [default = xcorrelate].
  • --no-shift <bool> — sets whether to apply the determined shifts in following recipes. set to TRUE if shifts appear too large. (bool; default: False). the full name of this option for the EsoRex configuration file is visir.visir_util_detect_shift.no-shift [default = False].
  • --no-reject <bool> — if true, images with bad statistics will not be rejected and no shift correction is done. (bool; default: True). the full name of this option for the EsoRex configuration file is visir.visir_util_detect_shift.no-reject [default = True].
  • --beampos <str> — define the positions of the beams. these positions are cut by the window to extract the single beam images. format: sign:x,y,window;sign:x,y,window;... where sign is "pos" or "neg" depending on whether the beam is positive or negative. the window is optional and defines the size of the cut image around the beam. the default window is the chop throw. e.g.: pos:50,60;neg:50,160; by default autodetection is attempted. (str; default: ´NONE´). the full name of this option for the EsoRex configuration file is visir.visir_util_detect_shift.beampos [default = NONE].
  • --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. (float; default: 3.0). the full name of this option for the EsoRex configuration file is visir.visir_util_detect_shift.eccmax [default = 3.0].
  • --keepfrac <float> — the fraction of pixels to keep for the initial median. (float; default: 0.9). the full name of this option for the EsoRex configuration file is visir.visir_util_clip.keepfrac [default = 0.9].
  • --kappa <float> — clip outside + or - kappa * sigma (the standard deviation). (float; default: 5.0). the full name of this option for the EsoRex configuration file is visir.visir_util_clip.kappa [default = 5.0].
  • --maxite <int> — max number of kappa-sigma clipping iterations. (int; default: 3). the full name of this option for the EsoRex configuration file is visir.visir_util_clip.maxite [default = 3].
  • --shift-beams <bool> — account for movements of the object defined in CRPIX[12]. (bool; default: True). the full name of this option for the EsoRex configuration file is visir.visir_util_clip.shift-beams [default = True].
  • --error-source <str> — defines the way errors are generated: img-stdev: stdev of image, timeseries: stdev of each pixel over the time axis of the cube, none: no error generation. (str; default: ´img-stdev´). the full name of this option for the EsoRex configuration file is visir.visir_util_clip.error-source [default = img-stdev].
  • --badimage <float> — if the percentage of clipped pixels is above this value, the whole image is considered bad. (float; default: 0.2). the full name of this option for the EsoRex configuration file is visir.visir_util_clip.badimage [default = 0.2].
  • --output-all <bool> — output a coadded image for each input file in addition to the complete coaddition. (bool; default: False). the full name of this option for the EsoRex configuration file is visir.visir_util_run_swarp.output-all [default = False].
  • --extra_config <str> — additional configuration parameters. (str; default: ´NONE´). the full name of this option for the EsoRex configuration file is visir.visir_util_run_swarp.extra_config [default = NONE].
  • --config_fname <str> — swarp configure file name. (str; default: ´/usr/share/cpl-plugins/visir-4.4.2/config/visir_default.swarp´). the full name of this option for the EsoRex configuration file is visir.visir_util_run_swarp.config_fname [default = /usr/share/cpl-plugins/visir-4.4.2/config/visir_default.swarp].
  • --nprocs <int> — maximum number of swarp processes that can be spawned simultaneously. (int; default: -1). the full name of this option for the EsoRex configuration file is visir.visir_util_run_swarp.nprocs [default = -1].
  • --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. (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].
  • --delete-temp <bool> — delete temporary files created during processing. (bool; default: True). the full name of this option for the EsoRex configuration file is visir.visir_img_reduce.delete-temp [default = True].
✨ heads up bestie: 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. 🎀

okay that's part 1 of this page and there is literally MORE coming, so stay with me, don't go anywhere 💜

✨ SEE ALSO ✨

okay bestie, so if you want the whole visir pipeline documentation as one big PDF, you can literally just download it here:

ftp://ftp.eso.org/pub/dfs/pipelines/visir/visir-pipeline-manual-1.4.pdf

and if you wanna see all the ESO pipelines that exist in the world (there are a lot, it's giving a whole ecosystem 💅), the overview lives at:

https://www.eso.org/sci/software/pipelines/

want the basics on the EsoRex program itself? that's chillin' in the esorex (1) man page, go say hi 🫶

and here's a fun one — you can call the pipelines from python using the python-cpl package. more info right here: https://packages.python.org/python-cpl/index.html

also, your other visir pipeline recipe besties, all of them, no gatekeeping:

  • visir_img_dark(7)
  • visir_img_ff(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_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)

🌈 VERSION 🌈

visir_img_reduce 4.4.2 — that's the one, periodt ✨

👑 AUTHOR 👑

the icon, the legend, the main character who wrote this:

Julian Taylor <jtaylor@partner.eso.org>

💌 BUG REPORTS 💌

found something cursed? 🫠 please report any problems to jtaylor@partner.eso.org.

alternatively, you can also send a report to the ESO User Support Department <usd-help@eso.org> — they got you, fr fr 🫶

📜 LICENSE 📜

okay so legal o'clock, but it's important so read it bestie:

This file is part of the VISIR Instrument Pipeline Copyright (C) 2015 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

aaaand that's the whole page, you made it to the end 🎀 this was visir_img_reduce, version 4.4.2, source visir_img_reduce and it's all about VISIR_IMG_REDUCE(7) — go forth and reduce those images, bestie, you're literally gonna slay 💖✨🦋

📦 where this page comes from