visir_util_convert_weight7

Usage

Overview

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.

Version

visir_util_convert_weight 4.4.2