VIMOS_IMA_DARK(7)

📦
version 4.1.7 · 2 versions
, in debian bookworm, ubuntu noble

✨ vimos_ima_dark ✨

okay bestie, welcome to the VIMOS imaging dark combination page — manual section 7, from the vimos recipes collection, and yes this is the glow-up version. sit down, hydrate, let's go 💅

NAME

vimos_ima_dark — Dark combination for imaging 🖤

SYNOPSIS

esorex vimos_ima_dark [OPTIONS] FILE.sof

DESCRIPTION

vimos_ima_dark is the VIMOS dark combine recipe. no cap.

What it does: it takes a whole list of dark frames and combines them into a mean dark frame. and if you want, it can also compare the output frame against a reference dark frame. optional, but iconic 🎀

the files it accepts in the SOF

so the program accepts these tags in the SOF, and honestly they're all doing their own little job:

  • DARK — a list of raw dark images (the main characters 👑)
  • MASTER_BIAS — a master bias frame
  • REFERENCE_DARK — optional reference dark frame
  • MASTER_BPM — optional master bad pixel map, or
  • MASTER_CONF — optional master confidence map
if no reference dark frame is made available, then no comparison will be done. meaning: there will be no output difference image and no stats table. literally nothing. zero. nada. 😭
and if neither a master bad pixel map nor a confidence map is provided, then the stats will be done assuming all pixels are good. manifesting perfection for every pixel, fr fr.

✨ OPTIONS ✨

every single one, in order, no skipping, we don't do that here 🫶

  • --combtype <str> — Combination algorithm (str; default: median). the full name of this option for the EsoRex configuration file is vimos.vimos_ima_dark.combtype [default = median].
  • --scaletype <str> — Scaling algorithm (str; default: exptime). the full name of this option for the EsoRex configuration file is vimos.vimos_ima_dark.scaletype [default = exptime].
  • --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_dark.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_dark.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_dark.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_dark.prettynames [default = False].
lowkey important: you can create a configuration file containing these options, along with suitable default values. pls refer to the details provided by the esorex --help command for that. iykyk 💜

SEE ALSO

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

and — plot twist — 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_det_noise(7), vimos_ima_fringe(7), vimos_ima_science(7), vimos_ima_standard(7), vimos_ima_twilight_flat(7), vmbias(7), vmdark(7), vmdet(7), vmifucalib(7), vmifucombine(7), vmifucombinecube(7), vmifuscience(7), vmifustandard(7), vmmoscalib(7), vmmosscience(7), vmspphot(7). the whole friend group, obsessed 🌈

VERSION

vimos_ima_dark 4.1.7 ⭐

AUTHOR

Jim Lewis <jrl@ast.cam.ac.uk> — the author, the moment, the icon 👑

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? tell someone, don't suffer in silence bestie 🙈

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 page, you ate that 🍓 this was vimos_ima_dark version 4.1.7, part of the vimos recipes family, and the page itself is dated 4.1.7 at the bottom (that's the footer doing its little thing). go combine some darks, bestie, you got this 💖✨🦋

📦 where this page comes from