HAWKI_LINEARITY_ANALYSE(7)

💖 HAWKI_LINEARITY_ANALYSE 💖

okay bestie, welcome to the hawki recipes section of the manual — this is hawki_linearity_analyse(7) and she is serving detector-linearity realness. pull up a chair, grab a boba, we're doing science. 🧋✨

---

✨ NAME ✨

hawki_linearity_analyse — the HAWKI linearity recipe. that's it, that's the name, she's iconic. 💅

---

🌈 SYNOPSIS 🌈

esorex hawki_linearity_analyse [OPTIONS] FILE.sof

like, you run her with esorex, you hand her your options, you hand her a .sof file. the way that the .sof is doing all the heavy lifting?? obsessed. 🫶

---

🦋 DESCRIPTION 🦋

hawki_linearity_analyse — no cap, this is the HAWKI detector linearity recipe.

so what's the vibe? she checks the linearity of the HAWKI detectors on a pixel by pixel basis. every single pixel, individually, getting its moment. main character energy for the entire detector. 👑

here's the files she accepts in the SOF, and bestie you must read this table because there are literally two of them:

• DARK_DETCHECK — a list of dark images 🌑
• FLAT_LAMP_DETCHECK — a list of dome flat images 💡

⚠️ All of the above are required. not "one of", not "whichever you have" — all. and lowkey important: there should be a dark frame for each DIT/NDIT combination used for the dome flats. iykyk. 🔥

---

🎀 OPTIONS 🎀

here come the flags, and yes, she has a full name for every single one for the EsoRex configuration file. don't ask me why, that's just how EsoRex is built. 💀

• --order <int> — polynomial order to fit. it's an int and the default is 3. her full EsoRex config-file name is hawki.hawki_linearity_analyse.order [default = 3]. 🍓
• --fitzero <bool> — fit the zeroth order term? yes or no bestie. it's a bool, and the default is False. her full EsoRex config-file name is hawki.hawki_linearity_analyse.fitzero [default = False]. 🎀
• --rchithr <float> — maximum allowable value of reduced chisq? it's a float, default 5.0. her full EsoRex config-file name is hawki.hawki_linearity_analyse.rchithr [default = 5.0]. 📊
• --satlim <float> — saturation limit? it's a float, default 65535.0. her full EsoRex config-file name is hawki.hawki_linearity_analyse.satlim [default = 65535.0]. 🌞
• --reflev <float> — reference flux level for the NL check. it's a float, default 10000.0. her full EsoRex config-file name is hawki.hawki_linearity_analyse.reflev [default = 10000.0]. 💜

💡 fyi bestie: you can literally create a configuration file containing these options, along with suitable default values. please refer to the details provided by the 'esorex --help' command. go read it, she's helpful, fr fr. 🫶

---

🌸 SEE ALSO 🌸

the full documentation for the hawki pipeline can be downloaded as a PDF file using this 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.

and yes, you can call the pipelines from python using the python-cpl package. see https://packages.python.org/python-cpl/index.html for further information. python girlies, this one's for you. 🐍✨

the other recipes of the hawki pipeline are — okay she's about to list the whole friend group, get ready, it's a lot and we love them all:

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_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. ate. 👑🌈

---

⭐ VERSION ⭐

hawki_linearity_analyse 2.4.11 — that's her, that's the version, slay. 💅

---

💜 AUTHOR 💜

Jim Lewis <jrl@ast.cam.ac.uk> — thank you for your service king 🫡

---

💀 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? don't suffer in silence bestie, tell somebody. 📣

---

🔥 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. (yes she said it in all caps, that's the legally binding vibe, respect it. 🙈)

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

---

and that's the whole page bestie!! 💖 this was hawki_linearity_analyse, version 2.4.11, from the hawki recipe family, straight out of the HAWKI_LINEARITY_ANALYSE(7) manual. go linearise those pixels, you absolute icon. periodt. ✨🦋🌸👑💅