table of contents
VISIR_UTIL_CONVERT_WEIGHT(7) | visir recipes | VISIR_UTIL_CONVERT_WEIGHT(7) |
NAME¶
visir_util_convert_weight - Conversion between different weight maps
SYNOPSIS¶
esorex visir_util_convert_weight [OPTIONS] FILE.sof
DESCRIPTION¶
The files listed in the Set Of Frames (sof-file) must be tagged: VISIR-weight-map.fits WEIGHT_MAP or VISIR-error-map.fits ERROR_MAP or VISIR-variance-map.fits VARIANCE_MAP VISIR-bpm-file.fits BPM (optional)
The relation between an error e, a weight w and a variance v is: e = sqrt(v) = 1/sqrt(w).
Depending on the setting of the boolean recipe parameters each input file will cause the following product(s) to be created (each with a FITS card ´HIERARCH ESO PRO CATG´ with the specified value) ERROR_MAP: An error map, requires input v >= 0, w > 0 WEIGHT_MAP: A weight map, requires input e > 0, v > 0 VARIANCE_MAP: A variance map, requires input e >= 0, w > 0 If for a given input the identical output is specified, the data unit(s) may still change according to the provided bad pixel map In a weight map product any bad pixel is set to 0.
In a variance or error map product any bad pixel is set to the value specified by the relevant recipe option.
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].
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 visir pipeline can be downloaded as a PDF file using the following URL:
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_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>.
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
4.4.2 | visir_util_convert_weight |