HAWKI_DARK_COMBINE(7)

🎀 NAME 🎀

hawki_dark_combine — the HAWKI dark combination recipe. that's her. that's the whole name. she combines darks and she does it flawlessly, periodt 💅

---

✨ SYNOPSIS ✨

esorex hawki_dark_combine [OPTIONS] FILE.sof

like, that's it. that's the whole incantation. you hand her a .sof file and some options and she goes 🦋

---

💫 DESCRIPTION 💫

okay so bestie, hawki_dark_combine is literally the HAWKI dark combine recipe. her whole job?

Combine a list of dark frames into a mean dark frame. and then — only if you want — compare the output frame to a reference dark frame. optional. a little treat. 🍓

The program accepts the following files in the SOF:

• DARK — a list of raw dark images
• REFERENCE_DARK — optional reference dark frame
• MASTER_BPM — optional master bad pixel map, or
• MASTER_CONF — optional master confidence map

no cap: if no reference dark frame is made available, then no comparison will be done. which means there will be no output difference image and no stats table. she's not being shady, there's just nothing to compare against 😭

and if neither a bad pixel mask nor a master confidence map is specified, all stats are done assuming all pixels are good. optimistic queen energy honestly 👑

---

💅 OPTIONS 💅

• --combtype <str> — Combination algorithm (str; default: ´median´). the full name of this option for the EsoRex configuration file is hawki.hawki_dark_combine.combtype [default = median].
• --scaletype <str> — Scaling algorithm (str; default: ´additive´). the full name of this option for the EsoRex configuration file is hawki.hawki_dark_combine.scaletype [default = additive].
• --xrej <bool> — True if using extra rejection cycle (bool; default: True). the full name of this option for the EsoRex configuration file is hawki.hawki_dark_combine.xrej [default = True].
• --thresh <float> — Rejection threshold in sigma above background (float; default: 5.0). the full name of this option for the EsoRex configuration file is hawki.hawki_dark_combine.thresh [default = 5.0].
• --ncells <int> — Number of cells for data channel stats (int; default: 8). the full name of this option for the EsoRex configuration file is hawki.hawki_dark_combine.ncells [default = 8].
• --prettynames <bool> — Use pretty output file names? (bool; default: False). the full name of this option for the EsoRex configuration file is hawki.hawki_dark_combine.prettynames [default = False].

---

and btw, you can make a configuration file holding these options plus suitable default values — go check the details provided by the esorex --help command. it's giving organized. it's giving prepared. we love to see it 🫶

---

🌈 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_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_compute_bkg(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)

the whole squad. the full roster. every single one of them iconic 💖

---

⭐ VERSION ⭐

hawki_dark_combine 2.4.11

---

👑 AUTHOR 👑

Jim Lewis <jrl@ast.cam.ac.uk>

---

🙈 BUG REPORTS 🙈

Please report any problems to jrl@ast.cam.ac.uk. Alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>.

found a bug? do NOT suffer in silence bestie, tell the people. they literally asked 💀

---

📜 LICENSE 📜

This file is part of the HAWKI Instrument Pipeline Copyright (C) 2015 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

read that carefully okay?? WITHOUT ANY WARRANTY is not a vibe she's playing with. it means what it means. no cap 🫡

---

and that's the whole page, bestie 🌸 this was hawki_dark_combine version 2.4.11, page HAWKI_DARK_COMBINE(7), out here repping the hawki recipes crew — stay calibrated, stay iconic, and go combine some darks 💜✨