FLAMES_CAL_PREP_SFF_OFPOS(7)

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

✨ FLAMES_CAL_PREP_SFF_OFPOS ✨ 💅

okay bestie, gather round, because this is flames_cal_prep_sff_ofpos, a recipe from the uves pipeline family, and it's literally the thing that figures out where your orders and your fibres are chilling. it's giving ✨position detective✨. no cap.

🌸 NAME 🌸

flames_cal_prep_sff_ofpos — determines order and fibre postions 🦋

🎀 SYNOPSIS 🎀

esorex flames_cal_prep_sff_ofpos [OPTIONS] FILE.sof

💜 DESCRIPTION 💜

so this is the fibre & order position determination procedure, and it is obsessed with getting your positions right. here's the tea on what you gotta feed it 🍓:

  • even, odd, all fibre images — FIB_FF_EVEN_RED, FIB_FF_ODD_RED, FIB_FF_ALL_RED
  • single fibre images — FIB_ORDEF_(REDL|REDU)
  • master bias frames — MASTER_BIAS_(REDL|REDU)
  • master slit flatfield frames — MASTER_SFLAT_(REDL|REDU)
  • order guess tables — FIB_ORD_GUE_(REDL|REDU)

and what does it hand back to you? a whole lil family of products, bestie 🫶:

  • Fibre order table — FIB_ORDEF_TABLE_chip
  • All fibre info table — FIB_FF_ALL_INFO_TAB
  • Odd fibre info table — FIB_FF_ODD_INFO_TAB
  • Even fibre info table — FIB_FF_EVEN_INFO_TAB
  • Slit flatfield common — SLIT_FF_COM_chip
  • Slit flatfield norm — SLIT_FF_NOR_chip
  • Slit flatfield data — SLIT_FF_DTC_chip
  • Slit flatfield sigma — SLIT_FF_SGC_chip
  • Slit flatfield bad pixel — SLIT_FF_BPC_chip
  • Slit flatfield boundary — SLIT_FF_BNC_chip
  • Fibre flatfield common — FIB_FF_COM_chip
  • Fibre flatfield norm — FIB_FF_NOR_chip
  • Fibre flatfield norm sigma — FIB_FF_NSG_chip

where chip=REDL and REDU. iconic. 👑

✨ OPTIONS ✨

  • --bias_method <str> — the bias subtraction method, bestie. M = use a master bias frame, N = no bias subtraction at all, V = subtract a constant bias level that you define with the bias_value parameter. it's a str and the default is M. full name for the EsoRex config file is flames_cal_prep_sff_ofpos.bias_method [default = M].
  • --bias_value <int> — the bias value, and it only matters if bias_method = V. it's an int and the default is 200. full name for the EsoRex config file is flames_cal_prep_sff_ofpos.bias_value [default = 200].
  • --clean_tmp_products <bool> — input data format. it's a bool and the default is False. full name for the EsoRex config file is flames_cal_prep_sff_ofpos.clean_tmp_products [default = False].
  • --cubify <bool> — the cubify switch. it's a bool and the default is True. full name for the EsoRex config file is flames_cal_prep_sff_ofpos.cubify [default = True].
  • --debug <bool> — whether or not to save intermediate results to your local directory. it's a bool and the default is False. full name for the EsoRex config file is uves.debug [default = False].
  • --ext_method <str> — the extraction method. it's a str and the default is opt. full name for the EsoRex config file is flames_cal_prep_sff_ofpos.ext_method [default = opt].
  • --fileprep <bool> — Slitff* and Fibreff* file preparation. heads up: if the fast extraction method is being used, this should be set to FALSE. it's a bool and the default is True. full name for the EsoRex config file is flames_cal_prep_sff_ofpos.fileprep [default = True].
  • --filter_switch <str> — the filter switch. it's a str and the default is none. full name for the EsoRex config file is flames_cal_prep_sff_ofpos.filter_switch [default = none].
  • --plotter <str> — any plots the recipe makes get redirected to whatever command you put here. real talk: the plotting command must contain the substring gnuplot, and it must be able to parse gnuplot syntax on its standard input. valid examples include gnuplot -persist and cat > mygnuplot$$.gp. want finer control over the plotting options? write yourself an executable script, like my_gnuplot.pl, that runs gnuplot after setting the gnuplot options you want (e.g. set terminal pslatex color). to turn plotting off entirely, set this parameter to no. it's a str and the default is no. full name for the EsoRex config file is uves.plotter [default = no].
  • --process_chip <str> — for RED arm data, process the redl chip, the redu chip, or both chip(s). it's a str and the default is both. full name for the EsoRex config file is uves.process_chip [default = both].
  • --sat_thr <int> — the saturation threshold. it's an int and the default is 55000. full name for the EsoRex config file is flames_cal_prep_sff_ofpos.sat_thr [default = 55000].
  • --save_flat_size <int> — to be sure you're actually using the flat part of a slit flat, you might need to subtract this bit. the default value -1 means automatic setting: if WCEN=520 then save_flat_size=0, else save_flat_size=2. values you set explicitly overwrite this rule. it's an int and the default is -1. full name for the EsoRex config file is flames_cal_prep_sff_ofpos.save_flat_size [default = -1].
💡 psst — you can make a configuration file with all these options in it, plus suitable default values. go check the details from the esorex --help command, bestie.

🦋 SEE ALSO 🦋

the full documentation for the uves pipeline can be downloaded as a PDF file from this URL:

ftp://ftp.eso.org/pub/dfs/pipelines/uves/uves-pipeline-manual-6.1.8.pdf

an overview over 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 yes, you can call the pipelines from python using the python-cpl package. see https://packages.python.org/python-cpl/index.html for further info. slay. 🐍

the other recipes of the uves pipeline, all lined up like the icons they are:

flames_cal_mkmaster(7), flames_cal_orderpos(7), flames_cal_predict(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(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 ⭐

flames_cal_prep_sff_ofpos 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>. they wanna hear it, fr fr. 📣

🌈 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. (yes bestie, that's the serious part, don't skip it 💀)

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.

and that's the whole page, periodt. 💅✨ this was flames_cal_prep_sff_ofpos version 6.1.8 from the uves recipes — take care of her, she's doing important work out here. 🫶🌸

📦 where this page comes from