hawki_step_compute_bkg(7)

hawki_step_compute_bkg7

(obsolete) background computing utility

Usage

esorex hawki_step_compute_bkg [OPTIONS] FILE.sof

Overview

(OBSOLETE) hawki_step_compute_bkg -- hawki background computation utility.

This recipe will create the associated background images for a given set of object images. If there are sky images, these will be used to compute the background, otherwise, the background is computed using a running mean on the object images. An optional mask can be supplied for the running mean.

The files listed in the Set Of Frames (sof-file) must be tagged: obj_basic_cal-file.fits BASIC_CALIBRATED or sky_basic_cal-file.fits SKY_BASIC_CALIBRATED and optionally for object masking: object_mask-file.fits OBJ_MASK offsets.fits OFFSETS_REFINED distortion_x.fits DISTORTION_X distortion_y.fits DISTORTION_Y

Options

--nmin_comb <int>

Minimum number of jitter frames to use the running median (int; default: 10). The full name of this option for the EsoRex configuration file is hawki.hawki_step_compute_bkg.nmin_comb [default = 10].

--nhalf_window <int>

Number of images at both sides of the current ima to use for bkg in running median (int; default: 7). The full name of this option for the EsoRex configuration file is hawki.hawki_step_compute_bkg.nhalf_window [default = 7].

--rejlow <int>

The number of frames with low level to reject (int; default: 2). The full name of this option for the EsoRex configuration file is hawki.hawki_step_compute_bkg.rejlow [default = 2].

--rejhigh <int>

The number of frames with high level to reject (int; default: 2). The full name of this option for the EsoRex configuration file is hawki.hawki_step_compute_bkg.rejhigh [default = 2].

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

hawki_step_compute_bkg 2.4.11

Releases

5 releases since Debian 8 (Jessie); the text changed 4 times.

  1. 8
  2. 9
  3. 10
  4. 11
  5. 12

Author

ESO Pipeline Group <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 <[email protected]>.

License

This file is part of the HAWKI Instrument Pipeline Copyright (C) 2002,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 Street, Fifth Floor, Boston, MA 02110-1301 USA

From cpl-plugin-hawki-doc 2.4.11+dfsg-1 in Debian 12 (Bookworm). Parsed by carta from the page's man source.