HAWKI_STEP_COMBINE(7)

💖 HAWKI_STEP_COMBINE(7) 💖

okay bestie, welcome to HAWKI_STEP_COMBINE — the hawki recipes glow-up zone ✨

---

🌸 NAME 🌸

hawki_step_combine — (OBSOLETE) Jitter image combination recipe 🫶

---

✨ SYNOPSIS ✨

esorex hawki_step_combine [OPTIONS] FILE.sof

---

🦋 DESCRIPTION 🦋

(OBSOLETE) hawki_step_combine — hawki combine jitter images. she's retired, she's iconic, she's still in the docs 💅

The files you list in the Set Of Frames (sof-file) have to be tagged like this, no cap:

• science-file.fits DIST_CORRECTED — or
• science-file.fits BKG_SUBTRACTED — or
• bpm-file.fits BPM (optional)
• bkg_bpm-file.fits BKG_BPM (optional)
• offsets-file.fits OFFSETS_REFINED (optional)

And the recipe makes one output for you, bestie:

• hawki_step_combine.fits (COMBINED) 🎀

---

🧚 the steps (in order, periodt)

• -Allocate an image with the proper combined size (depends on parameters --comb_meth and --borders)
• -Retrieve the offsets either from the offsets-file.fits or from the header
• -For each combined pixel, the contribution of each individual frame is added using a resampling kernel. If any of the pixels involved in the resampling is a bad pixel (defined in bpm-file.fits), it is not taken into account.

With the remaining pixels a minmax rejection is performed 🌈

Return code: esorex exits with an error code of 0 if the recipe completes successfully, or 1 otherwise. so like, 0 = slay, 1 = not slay 💀

---

💅 OPTIONS 💅

• --offset_max <int> — Maximum offset allowed (int; default: 1500). The full name of this option for the EsoRex configuration file is hawki.hawki_step_combine.offset_max [default = 1500]. 🔥
• --comb_meth <str> — Final size of combination (union / inter / first) (str; default: ´union´). The full name of this option for the EsoRex configuration file is hawki.hawki_step_combine.comb_meth [default = union]. ✨
• --rej <str> — Low and high number of rejected values (str; default: ´1,1´). The full name of this option for the EsoRex configuration file is hawki.hawki_step_combine.rej [default = 1,1]. 🍓
• --borders <int> — Border pixels trimmed (int; default: 4). The full name of this option for the EsoRex configuration file is hawki.hawki_step_combine.borders [default = 4]. 🎀
• --resamp_kernel <str> — Resampling kernel (default/tanh/sinc/sinc2/lanczos/hamming/hann) (str; default: ´default´). The full name of this option for the EsoRex configuration file is hawki.hawki_step_combine.resamp_kernel [default = default]. 🦋

---

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. 🐍

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_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) 💖

---

⭐ VERSION ⭐

hawki_step_combine 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>. fr fr, they wanna hear it 💜

---

📜 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 is hawki_step_combine version 2.4.11, straight outta the hawki recipes, dated and sourced exactly as the original footer said. go off, read responsibly, and may your exit codes always be 0 🎀✨