VMBIAS(7)

✨ VMBIAS(7) — vimos recipes ✨

okay bestie, welcome to vmbias, a page from the vimos recipes manual set. it's giving calibration-core, it's giving pipeline-girlie, and yes we're gonna read the whole thing together. grab a lil snack 🍓

---

🌸 NAME 🌸

vmbias — make a master bias from a set of raw bias frames. that's the whole vibe. 🎀

---

🦋 SYNOPSIS 🦋

esorex vmbias [OPTIONS] FILE.sof

yes queen, that's the invocation. esorex runs it, you hand it a .sof file, and you sprinkle [OPTIONS] on top like glitter. ✨

---

💖 DESCRIPTION 💖

so like, this recipe is the recipe for creating a master bias frame out of a whole stack of raw bias frames. lowkey iconic, highkey essential. 🫶

Input files, bestie:

• DO category: BIAS — Type: Raw — Explanation: Bias exposure — Required: Y
• DO category: CCD_TABLE — Type: Calib — Explanation: Bad pixel table — Required: .

Output files, and this is the moment:

• DO category: MASTER_BIAS — Data type: FITS image — Explanation: Master bias

heads up: a CCD table is only needed if you're asking for bad pixel cleaning. no badpixel clean, no CCD table, no stress. 💅

for even more detail (we love an overachiever), please refer to the VIMOS Pipeline User´s Guide.

---

👑 OPTIONS 👑

every single one, no skipping, we're thorough in this house:

• --AllowSingleFrames <bool> — frame combination method is ignored. (bool; default: True). the full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.singleframes [default = True].
• --StackMethod <str> — 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].
• --RemoveOverscan <bool> — remove overscan regions from the master bias (bool; default: True). the full name of this option for the EsoRex configuration file is vimos.Parameters.bias.overscan.remove [default = True].
• --CleanBadPixel <bool> — bad pixel correction on the master bias (bool; default: False). the full name of this option for the EsoRex configuration file is vimos.Parameters.bias.badpixel.clean [default = False].
• --CleanCosmic <bool> — cosmic ray removal from each raw bias (bool; default: False). the full name of this option for the EsoRex configuration file is vimos.Parameters.bias.cosmics.clean [default = False].
• --ComputeQC <bool> — compute QC1 parameters (bool; default: True). the full name of this option for the EsoRex configuration file is vimos.Parameters.bias.quality.enable [default = True].

also also also: you can make a configuration file with these options in it, defaults and all. just check the deets that esorex --help gives you. ✨

---

🌈 SEE ALSO 🌈

the full documentation for the vimos pipeline can be downloaded as a PDF file from this URL, and yes it's an ftp link, we respect the classics:

ftp://ftp.eso.org/pub/dfs/pipelines/vimos/vimos-pipeline-manual-6.9.pdf

an overview of all the existing ESO pipelines lives on this web page:

https://www.eso.org/sci/software/pipelines/

basic documentation about the EsoRex program is over at the esorex(1) man page.

and okay, plot twist, you can also call the pipelines from python using the python-cpl package. more info here: https://packages.python.org/python-cpl/index.html.

the other recipes of the vimos pipeline, aka the whole friend group: 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), vimos_ima_twilight_flat(7), vmdark(7), vmdet(7), vmifucalib(7), vmifucombine(7), vmifucombinecube(7), vmifuscience(7), vmifustandard(7), vmmoscalib(7), vmmosscience(7), vmspphot(7)

---

⭐ VERSION ⭐

vmbias 4.1.7

---

🧚 AUTHOR 🧚

ESO VIMOS Pipeline Team <https://support.eso.org>

---

💜 BUG REPORTS 💜

if something's broken (😭), 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>.

---

💅 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 lil rewrite is based on vmbias version 4.1.7, straight from the vimos recipes source. go make some master biases, you absolute legend. periodt. 👑✨