HAWKI_CAL_DARK(7)

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

💖 HAWKI_CAL_DARK(7) — hawki recipes, bestie edition 💖

okay so this is a page from the hawki recipes manual set, section 7, and literally the whole thing is about one recipe. grab a snack. 🍓

✨ NAME ✨

hawki_cal_dark — the (OBSOLETE) Dark recipe. yes bestie, OBSOLETE. capital letters. we'll get to that. 🙈

✨ SYNOPSIS ✨

esorex hawki_cal_dark [OPTIONS] FILE.sof

that's the whole vibe. you run it through esorex, you hand it options and a .sof file, and it does its lil thing. 💅

✨ DESCRIPTION ✨

okay so (OBSOLETE) — this is hawki_cal_dark, the Dark recipe. the files you list in the Set Of Frames (the sof-file, iykyk) must be tagged as either:

  • raw-file.fits DARK
  • raw-file.fits TEC_FLAT

those tags are non-negotiable. the recipe is checking. 👑

🌈 What it makes for you

the recipe creates these as output:

  • hawki_cal_dark.fits (DARK_IM) — the master dark. the main character, honestly. ⭐
  • hawki_cal_dark_bpmdark.fits (BPM_HOT) — the bad pixel mask that goes with the dark.
  • hawki_cal_dark_stats.fits (DARK_STATS) — statistics of the raw darks.

and optionally it also creates:

  • hawki_cal_dark_err.fits (DARK_ERR) — the error in the master dark.

🚦 Return code

esorex exits with an error code of 0 if the recipe completes successfully, or 1 otherwise. that's it. no in-between. slay. ✨

✨ OPTIONS ✨

one bullet per option, no skipping, we're thorough in this house 🫶

  • --sigma <float> — sigma for hot bad pixels detection (float; default: 10.0). the full name of this option for the EsoRex configuration file is hawki.hawki_cal_dark.sigma [default = 10.0].
  • --nsamples <int> — number of samples for RON computation (int; default: 100). the full name of this option for the EsoRex configuration file is hawki.hawki_cal_dark.nsamples [default = 100].
  • --hsize <int> — half size of the window for RON computation (int; default: 6). the full name of this option for the EsoRex configuration file is hawki.hawki_cal_dark.hsize [default = 6].
  • --zone <str> — Stats zone (str; default: ´512,512,1536,1536´). the full name of this option for the EsoRex configuration file is hawki.hawki_cal_dark.zone [default = 512,512,1536,1536].
  • --gain <float> — Detector nominal gain (e-/ADU) (float; default: -1.0). the full name of this option for the EsoRex configuration file is hawki.hawki_cal_dark.gain [default = -1.0].
  • --ron <float> — Detector nominal RON for a single readout (ADU) (float; default: -1.0). the full name of this option for the EsoRex configuration file is hawki.hawki_cal_dark.ron [default = -1.0].
🎀 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 this URL, bestie, write it down:

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:

the whole friend group. we love a squad. 💜

✨ VERSION ✨

hawki_cal_dark 2.4.11 — that's the one, no cap. 🔥

✨ AUTHOR ✨

ESO Pipeline Group <https://support.eso.org> — the icons who made this. 👑

✨ 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>. they literally want to hear from you, do not 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.

and that's the whole page, bestie 💖 this was hawki_cal_dark version 2.4.11, and it's the HAWKI_CAL_DARK(7) page from the hawki recipes manual — that's the title up top and the source/version down at the bottom, so you never have to scroll back. mwah. 💅✨🦋

📦 where this page comes from