VIMOS_IMA_TWILIGHT_FLAT(7)

💖 vimos_ima_twilight_flat — bestie edition 💖

okay so this is a page from the vimos recipes manual set, section 7, and it's all about vimos_ima_twilight_flat, the twilight flat combiner for imaging. strap in, it's actually so cute once you get it 🦋

---

✨ NAME ✨

vimos_ima_twilight_flat — Twilight flat combination for imaging

---

🎀 SYNOPSIS 🎀

esorex vimos_ima_twilight_flat [OPTIONS] FILE.sof

---

🌸 DESCRIPTION 🌸

vimos_ima_twilight_flat is the VIMOS twilight flat combine recipe, and its whole personality is: take a list of twilight flat frames and smoosh them into one mean frame. That's it, that's the job. 💅

Optionally — and this is the glow-up — it can compare the output frame to a reference twilight flat frame. vibe check, but for flats.

The program accepts the following files in the SOF:

• FLAT_TWILIGHT — a list of raw twilight flat images
• MASTER_BIAS — a master bias frame
• MASTER_DARK — a master dark frame
• REFERENCE_TWILIGHT_FLAT — optional reference twilight flat frame

lowkey important: if no reference twilight flat is made available, then no comparison will be done. Which means no output ratio image and no stats. so if you wanted the stats, bestie, you gotta bring the reference. 🙈

---

💅 OPTIONS 💅

• --lthr <float> — low rejection threshold for underexposed images (float; default: 4000.0). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.lthr [default = 4000.0].
• --hthr <float> — high rejection threshold for overexposed images (float; default: 60000.0). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.hthr [default = 60000.0].
• --combtype <str> — combination algorithm (str; default: ´median´). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.combtype [default = median].
• --scaletype <str> — scaling algorithm (str; default: ´multiplicative´). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.scaletype [default = multiplicative].
• --xrej <bool> — True if using extra rejection cycle (bool; default: True). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.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 vimos.vimos_ima_twilight_flat.thresh [default = 5.0].
• --ncells <int> — number of cells for diff image stats (int; default: 8). The full name of this option for the EsoRex configuration file is vimos.vimos_ima_twilight_flat.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 vimos.vimos_ima_twilight_flat.prettynames [default = False].

okay and heads up — 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. go look, it's giving documentation. 👑

---

🔥 SEE ALSO 🔥

The full documentation for the vimos pipeline can be downloaded as a PDF file using the following URL:

ftp://ftp.eso.org/pub/dfs/pipelines/vimos/vimos-pipeline-manual-6.9.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 vimos pipeline are vimos_ima_bias(7), vimos_ima_dark(7), vimos_ima_det_noise(7), vimos_ima_fringe(7), vimos_ima_science(7), vimos_ima_standard(7), vmbias(7), vmdark(7), vmdet(7), vmifucalib(7), vmifucombine(7), vmifucombinecube(7), vmifuscience(7), vmifustandard(7), vmmoscalib(7), vmmosscience(7), vmspphot(7)

---

⭐ VERSION ⭐

vimos_ima_twilight_flat 4.1.7

---

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

not me telling you to actually report bugs instead of just suffering in silence 😭 do it, they're nice.

---

👑 LICENSE 👑

This file is part of the VIMOS Instrument Pipeline Copyright (C) 2019 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

---

okay that's the whole thing, no cap. this was vimos_ima_twilight_flat, version 4.1.7, straight out of the vimos recipes collection. go combine some flats, bestie, you're gonna slay 💖✨🌸