HAWKI_CAL_FLAT(7)

📦
version 2.4.11 · 2 versions
, in debian bookworm, ubuntu noble

🌸 HAWKI_CAL_FLAT(7) — the hawki recipes manual, bestie edition 🌸

okay so welcome to HAWKI_CAL_FLAT(7), a page straight out of the hawki recipes manual. this one's about the twilight flat recipe and yes it is OBSOLETE, we'll get to that. grab a snack, we're doing all of it. 🍓

✨ NAME ✨

hawki_cal_flat — (OBSOLETE) Twillight flat recipe

🎀 SYNOPSIS 🎀

esorex hawki_cal_flat [OPTIONS] FILE.sof

💅 DESCRIPTION 💅

(OBSOLETE) hawki_cal_flat — HAWKI imaging flat-field creation from twillight images. that's the whole vibe. it makes flats. from twilight pics. 💫

so like, the input of the recipe files listed in the Set Of Frames (that's the sof-file) must be tagged as:

  • raw-file.fits FLAT

and the optional inputs are:

  • bpmdark-file.fits BPM_HOT
  • dark-file.fits DARK_IM
  • dark_err-file.fits DARK_ERR

the recipe creates as an output:

  • hawki_cal_flat_setxx.fits (FLAT_IM) — Master flat for filter xx
  • hawki_cal_flat_err_setxx.fits (FLAT_ERRMAP) — Master flat residuals
  • hawki_cal_flat_bpmflat_setxx.fits (BPM_COLD) — BPM from the flat
  • hawki_cal_flat_stats_setxx.fits (FLAT_STATS) — Stats of the individual flats

and optionally it also creates:

  • hawki_cal_flat_bpm_setxx.fits (BPM) — Bad pixel mask combining bpm from dark and flat
  • hawki_cal_flat_stats_ec_setxx.fits (FLAT_STATS_EVEN_COL) — Stats of the individual flats for even columns
  • hawki_cal_flat_stats_oc_setxx.fits (FLAT_STATS_ODD_COL) — Stats of the individual flats for odd columns
  • hawki_cal_flat_stats_er_setxx.fits (FLAT_STATS_EVEN_ROW) — Stats of the individual flats for even rows
  • hawki_cal_flat_stats_or_setxx.fits (FLAT_STATS_ODD_ROW) — Stats of the individual flats for odd rows

Return code: esorex exits with an error code of 0 if the recipe completes successfully or 1 otherwise. slay if it's a zero, sad if it's a one. 😭

✨ OPTIONS ✨

  • --zone <str> — Stats zone (str; default: ´1,1,2048,2048´). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.zone [default = 1,1,2048,2048].
  • --normalise <bool> — Flag to apply the normalisation (bool; default: False). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.normalise [default = False].
  • --second_pass <bool> — Flag to apply a second pass computation (bool; default: True). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.second_pass [default = True].
  • --sigma_badres <float> — sigma for detection of bad flat results (float; default: 1.0). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.sigma_badres [default = 1.0].
  • --sigma_bpm <float> — sigma for detection of bad pixels (float; default: 10.0). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.sigma_bpm [default = 10.0].
  • --lowval_bpm <float> — values of the flat below this will be included in the bpm. In units of final flat (normalised if normalise is on) (float; default: 0.1). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.lowval_bpm [default = 0.1].
  • --highval_bpm <float> — values of the flat above this will be included in the bpm. In units of final flat (normalized if normalise is on) (float; default: 10.0). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.highval_bpm [default = 10.0].
  • --select_auto <bool> — Flag to automatically select the good input frames (bool; default: True). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.select_auto [default = True].
  • --select_auto_max_bins <int> — Maximum number of frames requested (int; default: 10). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.select_auto_max_bins [default = 10].
  • --select_min_level <str> — Minimum ADU level for frames selection (str; default: ´-1.0´). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.select_min_level [default = -1.0].
  • --select_max_level <str> — Maximum ADU level for frames selection (str; default: ´25000´). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.select_max_level [default = 25000].
  • --select_max_rms <str> — Maximum RMS for frames selection (str; default: ´4000´). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.select_max_rms [default = 4000].
  • --select_min_nframes <int> — Minimum number of frames requested (int; default: 3). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.select_min_nframes [default = 3].
  • --extra_stats <bool> — Request for even/odd column/rows statistics (bool; default: False). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_flat.extra_stats [default = False].
ngl bestie, 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 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.

and the other recipes of the hawki pipeline, aka the whole friend group 👑:

⭐ VERSION ⭐

hawki_cal_flat 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>. if something's cursed, tell them, don't suffer in silence fr fr. 🙈

👑 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

and that's the whole page, bestie!! 💜 this was hawki_cal_flat version 2.4.11, served fresh from the hawki recipes corner of the manual, and it's the HAWKI_CAL_FLAT(7) page you just read every single word of. no cap. go make some flats (or don't, it's obsolete 😭). periodt. ✨🎀🫶

📦 where this page comes from