UVES_CAL_MFLAT(7)

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

💖 uves_cal_mflat(7) — the UVES recipe page, bestie edition 💖

okay so this is uves_cal_mflat, a page from the uves recipes manual. yes she's a manual page, yes she's serving, let's get into it 🎀

✨ NAME ✨

uves_cal_mflat — Creates the master flat field frame

like. she MAKES the master flat. that's the whole job. iconic behavior honestly 👑

🌸 SYNOPSIS 🌸

esorex uves_cal_mflat [OPTIONS] FILE.sof

🦋 DESCRIPTION 🦋

okay so here's the whole vibe: this recipe builds you a master flat frame, and it does it in five steps, no skips, no shortcuts:

  1. subtract the master bias frame from each flat field frame
  2. divide each flat field frame by the exposure time for that frame
  3. take the median of all the bias subtracted, normalized raw flat frames
  4. optionally subtract the master dark frame
  5. subtract the background

…and that gets you the bias subtracted, optionally dark subtracted, normalized, background subtracted master flat-field frame. she's fully prepped. she's ready. 💅

Symbolically, because we love a formula moment:

masterflat = median( (flat_i - masterbias)/exptime_i ) - masterdark/exptime
            - background.

Now the input tea ☕ — the input flat field frames must have the same tag, and that tag must match (I|D|S|T|SCREEN|)FLAT_(BLUE|RED). examples being given: TFLAT_BLUE or FLAT_RED. no cap.

Also you must provide, for each chip:

  • a master bias (MASTER_BIAS_xxxx)
  • an ordertable (ORDER_TABLE_xxxx)

where xxxx = BLUE, REDL, REDU.

A master dark frame (MASTER_(P)DARK_xxxx) may optionally be provided — optional, bestie, she's flexible like that.

On blue input the recipe computes one master flat field frame. On red input the recipe produces a master flat field frame for each chip, and it'll be named one of: MASTER_FLAT_xxxx, MASTER_IFLAT_xxxx, MASTER_DFLAT_xxxx, MASTER_TFLAT_xxxx or MASTER_SCREEN_FLAT_xxxx. so many names, all slaying 🌈

💅 OPTIONS 💅

  • --backsub.mmethod <str> — Background measuring method. If it's equal to ´median´, the background gets sampled using the median of a subwindow. If it's ´minimum´, the subwindow minimum value is used instead. And if it's ´no´, no background subtraction is done, periodt. (str; default: ´median´). The full name of this option for the EsoRex configuration file is uves_cal_mflat.backsub.mmethod [default = median].
  • --backsub.npoints <int> — This is the number of columns in interorder space used to sample the background. (int; default: 82). The full name of this option for the EsoRex configuration file is uves_cal_mflat.backsub.npoints [default = 82].
  • --backsub.radiusy <int> — The height (in pixels) of the background sampling window is (2*radiusy + 1). heads up: this parameter is not corrected for binning. (int; default: 2). The full name of this option for the EsoRex configuration file is uves_cal_mflat.backsub.radiusy [default = 2].
  • --backsub.sdegree <int> — Degree of interpolating splines. Currently only degree = 1 is supported (so like, don't get creative with it). (int; default: 1). The full name of this option for the EsoRex configuration file is uves_cal_mflat.backsub.sdegree [default = 1].
  • --backsub.smoothx <float> — If spline interpolation is used to measure the background, the x-radius of the post-smoothing window is (smoothx * image_width). Here, ´image_width´ is the image width after binning. If it's negative, the default values are used: (25.0/4096) for blue flat-field frames, (50.0/4096) for red flat-field frames, (300.0/4096) for blue science frames and (300.0/4096) for red science frames. (float; default: -1.0). The full name of this option for the EsoRex configuration file is uves_cal_mflat.backsub.smoothx [default = -1.0].
  • --backsub.smoothy <float> — If spline interpolation is used to measure the background, the y-radius of the post-smoothing window is (smoothy * image_height). Here, ´image_height´ is the image height after binning. If it's negative, the default values are used: (100.0/2048) for blue flat-field frames, (300.0/2048) for red flat-field frames, (200.0/2048) for blue science frames and (500.0/2048) for red science frames. (float; default: -1.0). The full name of this option for the EsoRex configuration file is uves_cal_mflat.backsub.smoothy [default = -1.0].
  • --debug <bool> — Whether or not to save intermediate results to local directory. (bool; default: False). The full name of this option for the EsoRex configuration file is uves.debug [default = False].
  • --norm_method <str> — Method used to build master frame. (str; default: ´explevel´). The full name of this option for the EsoRex configuration file is uves_cal_mflat.norm_method [default = explevel].
  • --plotter <str> — Any plots produced by the recipe are redirected to the command specified by this parameter. The plotting command must contain the substring ´gnuplot´ and must be able to parse gnuplot syntax on its standard input. Valid examples of such a command may include ´gnuplot -persist´ and ´cat > mygnuplot$$.gp´. A finer control of the plotting options can be obtained by writing an executable script, e.g. my_gnuplot.pl, that executes gnuplot after setting the desired gnuplot options (e.g. set terminal pslatex color). To turn off plotting, set this parameter to ´no´. (str; default: ´no´). The full name of this option for the EsoRex configuration file is uves.plotter [default = no].
  • --process_chip <str> — For RED arm data, process the redl, redu, or both chip(s). (str; default: ´both´). The full name of this option for the EsoRex configuration file is uves.process_chip [default = both].
✨ psst — 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 check her out 🫶

🔥 SEE ALSO 🔥

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

ftp://ftp.eso.org/pub/dfs/pipelines/uves/uves-pipeline-manual-6.1.8.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 uves pipeline are — okay bestie, deep breath, this is the whole friend group:

flames_cal_mkmaster(7), flames_cal_orderpos(7), flames_cal_predict(7), flames_cal_prep_sff_ofpos(7), flames_cal_wavecal(7), flames_obs_redchain(7), flames_obs_scired(7), flames_utl_unpack(7), uves_cal_cd_align(7), uves_cal_mbias(7), uves_cal_mdark(7), uves_cal_mflat_combine(7), uves_cal_mkmaster(7), uves_cal_orderpos(7), uves_cal_predict(7), uves_cal_response(7), uves_cal_tflat(7), uves_cal_wavecal(7), uves_obs_redchain(7), uves_obs_scired(7), uves_utl_ima_arith(7), uves_utl_remove_crh_single(7)

⭐ VERSION ⭐

uves_cal_mflat 6.1.8

👑 AUTHOR 👑

Jonas M. Larsen <cpl@eso.org>

💀 BUG REPORTS 💀

Please report any problems to cpl@eso.org. Alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>.

like pls do actually report them, they wanna know 🙈

🎀 LICENSE 🎀

This file is part of the FLAMES/UVES Pipeline Copyright (C) 2004, 2005, 2006, 2007 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 02111-1307 USA

okay that's the whole page!! 💖 this was uves_cal_mflat, version 6.1.8, from the uves recipes set — and yes she's dated 6.1.8 too, matching her whole energy. now go make that master flat, bestie, you've got this 🧚✨

📦 where this page comes from