VISIR_UTIL_CONVERT_WEIGHT(7)

πŸ“¦
version 4.4.2 Β· 2 versions
, in debian bookworm, ubuntu noble

πŸ‘‘ NAME πŸ’…

visir_util_convert_weight β€” bestie, it's literally Conversion between different weight maps ✨


πŸ¦‹ SYNOPSIS 🌸

esorex visir_util_convert_weight [OPTIONS] FILE.sof

πŸ’– DESCRIPTION ✨

okay so first things first: the files you list in your Set Of Frames (aka the sof-file) have to be tagged, no cap. Like this:

  • VISIR-weight-map.fits WEIGHT_MAP
  • VISIR-error-map.fits ERROR_MAP
  • VISIR-variance-map.fits VARIANCE_MAP
  • VISIR-bpm-file.fits BPM (this one's optional, she's just here if you want her 🫢)

and the whole math of the situation, the relationship between an error e, a weight w and a variance v is:

e = sqrt(v) = 1/sqrt(w)

it's giving iconic formula ngl πŸ’…


so depending on how you set the boolean recipe parameters, every input file is gonna cause the following product(s) to be created β€” and each one comes with a FITS card HIERARCH ESO PRO CATG holding the specified value:

  • ERROR_MAP β€” an error map. needs input v >= 0, w > 0
  • WEIGHT_MAP β€” a weight map. needs input e > 0, v > 0
  • VARIANCE_MAP β€” a variance map. needs input e >= 0, w > 0

now if for a given input you asked for the identical output, the data unit(s) may still change according to the provided bad pixel map. slay.

in a weight map product, any bad pixel is set to 0. periodt.

in a variance or error map product, any bad pixel is set to the value specified by the relevant recipe option (yes that's --bad_value, we'll get there πŸ‘‡).


πŸŽ€ OPTIONS πŸŽ€

  • --error <bool> β€” Convert to error (bool; default: True). The full name of this option for the EsoRex configuration file is visir.visir_util_convert_weight.error [default = True].
  • --weight <bool> β€” Convert to weight. Bad pixels are seto to 0 (bool; default: False). The full name of this option for the EsoRex configuration file is visir.visir_util_convert_weight.weight [default = False].
  • --variance <bool> β€” Convert to variance. Bad pixels are seto to 0 (bool; default: False). The full name of this option for the EsoRex configuration file is visir.visir_util_convert_weight.variance [default = False].
  • --bad_value <float> β€” The value to use for any bad pixel in an error or variance map (float; default: 3.4028234663852886e+38). The full name of this option for the EsoRex configuration file is visir.visir_util_convert_weight.bad_value [default = 3.4028234663852886e+38].
  • --bad_flag <bool> β€” The value used to flag a bad pixel in an input bad pixel map. True: 1. False: 0. (bool; default: True). The full name of this option for the EsoRex configuration file is visir.visir_util_convert_weight.bad_flag [default = True].
πŸ’‘ quick 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.

🌈 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. 🐍✨

and the other recipes of the visir pipeline, the whole squad, 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_spc_wcal_ech(7), visir_old_util_destripe(7), visir_spc_reduce(7), visir_util_apply_calib(7), visir_util_clip(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_util_convert_weight 4.4.2


🫢 AUTHOR 🫢

Lars Lundin https://support.eso.org


😭 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. (fr fr, they wanna hear about it πŸ™ˆ)


πŸ’€ LICENSE πŸ’€

this file is part of the VISIR Instrument Pipeline Copyright (C) 2011 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 πŸ’– you just read visir_util_convert_weight 4.4.2, straight out of the visir recipes manual, and honestly? she ate. go convert some weight maps, ily, mwah πŸŽ€βœ¨

πŸ“¦ where this page comes from