HAWKI_STEP_COMPUTE_BKG(7)

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

πŸ’– HAWKI_STEP_COMPUTE_BKG πŸ’–

okay so bestie, welcome to the hawki recipes section of the manual β€” this one's called hawki_step_compute_bkg(7) and she's here to talk about backgrounds. yes, the vibes behind your objects. let's get into it 🫢


✨ NAME ✨

hawki_step_compute_bkg β€” (OBSOLETE) Background computing utility

ngl the "(OBSOLETE)" is right there in the name, bestie. she's serving retired icon energy. still documented, still real, just… retired. πŸ’€

🌈 SYNOPSIS 🌈

esorex hawki_step_compute_bkg [OPTIONS] FILE.sof

πŸ¦‹ DESCRIPTION πŸ¦‹

(OBSOLETE) hawki_step_compute_bkg β€” it's the hawki background computation utility, periodt.

So here's the tea: this recipe makes the associated background images for a given set of object images. πŸŽ€

  • if there are sky images, those get used to compute the background
  • otherwise, the background is computed using a running mean on the object images
  • and an optional mask can be supplied for that running mean πŸ‘‘

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

  • obj_basic_cal-file.fits β†’ BASIC_CALIBRATED
  • 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

like, the tags are not optional, the masking files are optional. read it again if u need to, i'll wait πŸ’…


✨ OPTIONS ✨

  • --nmin_comb <int> β€” minimum number of jitter frames needed 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].

and fyi 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 hawki pipeline can be downloaded as a PDF file using the following URL:

ftp://ftp.eso.org/pub/dfs/pipelines/hawki/hawki-pipeline-manual-2.4.11.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.

The other recipes of the hawki pipeline are:

  • hawki_cal_dark(7)
  • hawki_cal_distortion(7)
  • hawki_cal_flat(7)
  • hawki_cal_zpoint(7)
  • hawki_dark_combine(7)
  • hawki_detector_noise(7)
  • hawki_linearity_analyse(7)
  • hawki_sci_jitter(7)
  • hawki_science_postprocess(7)
  • hawki_science_process(7)
  • hawki_standard_process(7)
  • hawki_step_apply_dist(7)
  • hawki_step_basic_calib(7)
  • hawki_step_combine(7)
  • hawki_step_detect_obj(7)
  • hawki_step_photom_2mass(7)
  • hawki_step_refine_offsets(7)
  • hawki_step_stats(7)
  • hawki_step_stitch(7)
  • hawki_step_subtract_bkg(7)
  • hawki_tec_filtchk(7)
  • hawki_twilight_flat_combine(7)
  • hawki_util_gendist(7)
  • hawki_util_stdstars(7)

⭐ VERSION ⭐

hawki_step_compute_bkg 2.4.11


πŸ‘‘ 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 <usd-help@eso.org>.

(like, they want your bug reports, bestie, don't be shy πŸ™ˆ)


πŸ“œ 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


okay that's the whole page bestie, you ate πŸ’…βœ¨ this was hawki_step_compute_bkg version 2.4.11, straight from the hawki recipes collection β€” go forth and compute those backgrounds, ily πŸ«ΆπŸŽ€
πŸ“¦ where this page comes from