VMIFUCALIB(7)

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

💖 NAME 💖

okay so bestie, vmifucalib — she generates IFU calibrations from a whole little squad of flat and arc lamp exposures. that's the whole vibe. ✨

🎀 SYNOPSIS 🎀

esorex vmifucalib [OPTIONS] FILE.sof

🌸 DESCRIPTION 🌸

okay so this recipe is doing the MOST (affectionate) and honestly? we love her for it. she produces three things:

  • the extraction mask
  • the wavelength calibration
  • the relative transmission correction

and she does it from a set of flat field exposures plus one arc lamp exposure, all in IFU mode. 💅

📥 Input files (the guest list) 📥

  • IFU_SCREEN_FLAT — type: Raw — flat field — required: Y 🫶
  • IFU_ARC_SPECTRUM — type: Raw — arc spectrum — required: .
  • LINE_CATALOG — type: Calib — arc line catalog — required: .
  • MASTER_BIAS — type: Calib — master bias — required: Y 🫶
  • IFU_IDENT — type: Calib — fiber identification — required: .
  • CCD_TABLE — type: Calib — bad pixel table — required: .

📤 Output files (the glow-up results) 📤

  • IFU_MASTER_SCREEN_FLAT — data type: FITS image — stack of all raw flat fields
  • IFU_ARC_SPECTRUM_EXTRACTED — data type: FITS image — extracted arc spectra
  • IFU_FLAT_SPECTRUM_EXTRACTED — data type: FITS image — extracted flat field spectra
  • IFU_TRACE — data type: FITS table — extraction mask
  • IFU_IDS — data type: FITS table — wavelength calibration
  • IFU_TRANSMISSION — data type: FITS table — transmission correction

now, the tea ☕: you may skip the arc spectrum exposure in the input, but bestie, hear me — in that case no wavelength calibration and no fiber relative transmission correction will be computed, and further reduction of associated scientific data will not be possible. like, at all. 😭 the only products in that case are the stack of all the input raw flat field exposures, and the extraction mask. that's it. that's the whole meal.

if you do specify the arc spectrum exposure in input, then a line catalog must also be given. non-negotiable. ✋

the fiber identification table, if given, makes sure all spectra get safely identified and assigned to the correct spatial position — but in most cases it's gonna be possible to reduce the data even without specifying this table in the input SOF. lowkey flexible of her. 💅

a CCD table must be specified only if a bad pixel cleaning is requested. no bad pixels, no table, no problem. 🦋

for more details, please refer to the VIMOS Pipeline User´s Guide. (yes, go read it, i'll wait 🫶)

✨ OPTIONS ✨

  • --AllowSingleFrames <bool> — flat fields 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> — flat fields combination method. (str; default: ´MinMax´). the full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.method [default = MinMax].
  • --KSigmaLow <float> — low threshold for 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 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 rejection method. (int; default: 0). the full name of this option for the EsoRex configuration file is vimos.Parameters.stacking.minmax.minimum [default = 0].
  • --MaxRejection <int> — number of highest rejected values for 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> — 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 master flat field. (bool; default: False). the full name of this option for the EsoRex configuration file is vimos.Parameters.badpixel.clean [default = False].
  • --ApplyTransmission <bool> — apply transmission correction to extracted arc lamp spectra (bool; default: True). the full name of this option for the EsoRex configuration file is vimos.Parameters.apply.transmission [default = True].
  • --MaxIdsRms <float> — maximum tolerated RMS of residuals in IDS fit (float; default: 2.0). the full name of this option for the EsoRex configuration file is vimos.Parameters.ids.maxrms [default = 2.0].
  • --LineIdent <str> — arc line identification method. (str; default: ´Blind´). the full name of this option for the EsoRex configuration file is vimos.Parameters.line.ident.method [default = Blind].
  • --MaxTraceRejection <int> — maximum percentage of rejected positions in fiber spectra tracing (int; default: 33). the full name of this option for the EsoRex configuration file is vimos.Parameters.trace.failed [default = 33].
  • --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].
ngl 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. 👑

👀 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), vimos_ima_twilight_flat(7), vmbias(7), vmdark(7), vmdet(7), vmifucombine(7), vmifucombinecube(7), vmifuscience(7), vmifustandard(7), vmmoscalib(7), vmmosscience(7), vmspphot(7). the whole friend group fr fr 💖

⭐ VERSION ⭐

vmifucalib 4.1.7

👑 AUTHOR 👑

ESO VIMOS Pipeline Team and VIMOS Consortium <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>. don't be shy, they wanna hear it 🫶

🎀 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 bestie that's the whole page, we ate and left no crumbs 💅✨ this was vmifucalib version 4.1.7, dated 4.1.7, straight from the vimos recipes collection — mwah, love u, go calibrate something 🦋💖

📦 where this page comes from