FORS_DARK(7)

✨ fors_dark — the master dark frame recipe, bestie edition ✨

okay so this is fors_dark(7), a page from the fors recipes collection, and it's literally the glow-up guide for turning your raw darks into one gorgeous master dark. pull up a chair, we're doing science 💅

---

🌸 NAME 🌸

fors_dark — compute master dark frame. that's it, that's the whole job, and she does it flawlessly 🫶

---

🦋 SYNOPSIS 🦋

esorex fors_dark [OPTIONS] FILE.sof

yep, you call her through esorex, you hand her your FILE.sof, and you sprinkle in [OPTIONS] as you please. no cap ✨

---

🎀 DESCRIPTION 🎀

so the vibe here is: this recipe takes your input raw DARK frames and combines them into a master dark frame. how? by subtracting the master bias and then using whichever stacking method you told her to use. simple, iconic, effective 💖

oh and — the overscan regions, if they're present? removed from the result. gone. not invited to the party. periodt.

📥 Input files (what she needs from you)

• DARK — DO category: DARK, type: Raw, explanation: Dark frame, Required: Y
• MASTER_BIAS — DO category: MASTER_BIAS, type: FITS image, explanation: Master bias, Required: Y

📤 Output files (what she gives back)

• MASTER_DARK — DO category: MASTER_DARK, data type: FITS image, explanation: Master dark frame

she said "give me your darks and your master bias and I'll hand you a whole master dark," and honestly? main character energy 👑

---

💅 OPTIONS 💅

every single one, no skips, we don't gatekeep here:

• --stack_method <str> — the frames combination method. it's a str, default is ´median´. the full name of this option for the EsoRex configuration file is fors.fors_dark.stack_method [default = median].
• --minrejection <int> — number of lowest values to be rejected. it's an int, default is 1. full name for the EsoRex config file: fors.fors_dark.minrejection [default = 1].
• --maxrejection <int> — number of highest values to be rejected. it's an int, default is 1. full name for the EsoRex config file: fors.fors_dark.maxrejection [default = 1].
• --klow <float> — low threshold in the ksigma method. it's a float, default is 3.0. full name for the EsoRex config file: fors.fors_dark.klow [default = 3.0].
• --khigh <float> — high threshold in the ksigma method. it's a float, default is 3.0. full name for the EsoRex config file: fors.fors_dark.khigh [default = 3.0].
• --kiter <int> — max number of iterations in the ksigma method. it's an int, default is 999. full name for the EsoRex config file: fors.fors_dark.kiter [default = 999].

💡 little heads-up bestie: you can absolutely make a configuration file holding all these options with whatever default values you like. want the deets? go ask 'esorex --help', she'll tell you everything.

---

🌈 SEE ALSO 🌈

the full documentation for the fors pipeline? downloadable as a PDF, just hit up this URL:

ftp://ftp.eso.org/pub/dfs/pipelines/fors/fors-pipeline-manual-4.9.pdf

want an overview of all the existing ESO pipelines? it's right here: https://www.eso.org/sci/software/pipelines/.

basic documentation about the EsoRex program itself lives in the esorex (1) man page 🧚

and get this — you can call the pipelines from python using the python-cpl package. see https://packages.python.org/python-cpl/index.html for more info. we love a python moment 💜

the other recipes of the fors pipeline, all of them, in order, because nobody gets left out:

fors_align_sky(7), fors_align_sky_lss(7), fors_bias(7), fors_calib(7), fors_config(7), fors_detect_objects(7), fors_detect_spectra(7), fors_extract(7), fors_extract_objects(7), fors_extract_slits(7), fors_flatfield(7), fors_img_science(7), fors_img_screen_flat(7), fors_img_sky_flat(7), fors_normalise_flat(7), fors_photometry(7), fors_pmos_calib(7), fors_pmos_extract(7), fors_pmos_science(7), fors_remove_bias(7), fors_resample(7), fors_science(7), fors_spec_mflat(7), fors_subtract_sky(7), fors_subtract_sky_lss(7), fors_sumflux(7), fors_trace_flat(7), fors_wave_calib(7), fors_wave_calib_lss(7), fors_zeropoint(7)

a whole squad. a friend group. love that for them 🫶

---

⭐ VERSION ⭐

fors_dark 5.5.7 — that's the one, that's the version, iconic.

---

👑 AUTHOR 👑

Jonas M. Larsen <usd-help@eso.org> — thank you for your service, king 🌟

---

💀 BUG REPORTS 💀

please report any problems to usd-help@eso.org. alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>. (same address, twice, because they really want to hear from you 😭 not me double-checking that, they wrote it like that, fr fr.)

---

📜 LICENSE 📜

this file is currently part of the FORS 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 St, Fifth Floor, Boston, MA 02110-1301 USA.

read the license, bestie, it's giving legally binding and also it's giving slay 🎀

---

and that's the whole page!! this was fors_dark, version 5.5.7, living in manual page FORS_DARK(7) — go make yourself a beautiful master dark, you've got this 💖✨🦋🌸