VMDARK(7)

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

💖 vmdark — like, the manual page for vmdark(7) 💖

okay bestie, sit down, hydrate, because we're building a master dark frame from a whole pile of raw dark frames and honestly? it's giving ✨astronomy✨

🌸 NAME 🌸

vmdark — create a master dark from a set of raw dark frames. that's the whole job. that's the assignment. periodt. 💅

🦋 SYNOPSIS 🦋

esorex vmdark [OPTIONS] FILE.sof

yes queen, that's it. options go in, a .sof file goes in, magic comes out. 🎀

✨ DESCRIPTION ✨

so this recipe is the one that takes a bunch of raw dark frames and turns them into one master dark frame. it's the dark-frame glow-up, fr fr. 🔥

Input files (what you gotta hand over):

  • DO category: DARK — Type: Raw — Explanation: Dark exposure — Required: Y
  • DO category: MASTER_BIAS — Type: Calib — Explanation: Master bias — Required: Y
  • DO category: CCD_TABLE — Type: Calib — Explanation: Bad pixel table — Required: . (only when it's needed, iykyk)

Output files (what you get back, and it ate):

  • DO category: MASTER_DARK — Data type: FITS image — Explanation: Master dark
🫶 heads up bestie: a CCD table must be specified only if a bad pixel cleaning is requested. no cleaning, no table, no stress.

for more details, please refer to the VIMOS Pipeline User´s Guide. (yes, that accent is in there, I don't make the rules 💀)

💅 OPTIONS 💅

okay this is the fun part. every single flag, no skips, no skimming. we're doing all of them. 🌈

  • --AllowSingleFrames <bool> — frame combination method is ignored. like, it's just not invited to the party. (bool; default: True). the full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.singleframes [default = True].
  • --StackMethod <str> — the frame combination method. (str; default: Median). the full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.method [default = Median].
  • --KSigmaLow <float> — low threshold for the K-sigma clipping method. (float; default: 5.0). the full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.ksigma.low [default = 5.0].
  • --KSigmaHigh <float> — high threshold for the K-sigma clipping method. (float; default: 5.0). the full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.ksigma.high [default = 5.0].
  • --MinRejection <int> — number of lowest rejected values for the rejection method. (int; default: 1). the full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.minmax.minimum [default = 1].
  • --MaxRejection <int> — number of highest rejected values for the rejection method. (int; default: 1). the full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.minmax.maximum [default = 1].
  • --BiasMethod <str> — the bias removal method. (str; default: Zmaster). the full name of this option for the EsoRex configuration file is vimos.Parameters.bias.removing.method [default = Zmaster].
  • --CleanBadPixel <bool> — bad pixel correction on the master dark. (bool; default: False). the full name of this option for the EsoRex configuration file is vimos.Parameters.badpixel.clean [default = False].
  • --CleanCosmic <bool> — cosmic ray events cleaning from raw darks. (bool; default: True). the full name of this option for the EsoRex configuration file is vimos.Parameters.cosmics.clean [default = True].
  • --CosmicThreshold <float> — threshold to identify cosmic ray candidates. (float; default: 4.0). the full name of this option for the EsoRex configuration file is vimos.Parameters.cosmics.threshold [default = 4.0].
  • --CosmicRatio <float> — min ratio between peak and nearby pixels for a cosmic ray. (float; default: 2.0). the full name of this option for the EsoRex configuration file is vimos.Parameters.cosmics.ratio [default = 2.0].
  • --ComputeQC <bool> — compute QC1 parameters. (bool; default: True). the full name of this option for the EsoRex configuration file is vimos.Parameters.quality.enable [default = True].
🎀 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. bestie behavior tbh.

👑 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. (yes, python girlies, we're included 💜)

the other recipes of the vimos pipeline are, and I'm listing every single one because we don't do half-finished here:

⭐ VERSION ⭐

vmdark 4.1.7

💖 AUTHOR 💖

ESO VIMOS Pipeline Team <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>.

(not me telling you to file bug reports but like… do it, they're nice, they want to help 😭)

🌸 LICENSE 🌸

this file is part of the VIMOS Instrument Pipeline Copyright (C) 2002-2005 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.

and that's the whole page bestie!! 🎀 this was vmdark version 4.1.7 from the vimos recipes crew — go make something iconic with it. mwah 💋✨

📦 where this page comes from