FLAMES_OBS_SCIRED(7)

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

FLAMES_OBS_SCIRED 💖

okay bestie, so this is the manual for flames_obs_scired, which lives in the uves recipes section of the manual (section 7, iykyk). it's a recipe for reducing a FLAMES science image. it's a long one so we're doing this in parts — part 1, let's go 🫶

✨ NAME ✨

flames_obs_scired — reduces a FLAMES science image. that's it, that's the whole vibe 💅

✨ SYNOPSIS ✨

esorex flames_obs_scired [OPTIONS] FILE.sof

yes bestie, that's the whole invocation. esorex, the recipe name, your options, and the .sof file. slay.

✨ DESCRIPTION ✨

okay so this is the fibre & order position determination procedure, and it's giving "please feed me exactly the right files or i will simply pass away" 😭. here's what you should feed the recipe:

  • science fibre images (FIB_SCI_RED, FIB_SCI_SIM_RED, FIB_SCI_SIM_RED) 🧚
  • single fibre images, FIB_ORDEF_(REDL|REDU)
  • master bias frames, MASTER_BIAS_(REDL|REDU)
  • fibre order table, FIB_ORDEF_TABLE_(REDL|REDU)
  • slit flatfield common, SLIT_FF_COM_(REDL|REDU)
  • slit flatfield norm, SLIT_FF_NOR_(REDL|REDU)
  • slit flatfield data, SLIT_FF_DTC_(REDL|REDU)
  • slit flatfield sigma, SLIT_FF_SGC_(REDL|REDU)
  • slit flatfield bad pixel, SLIT_FF_BPC_(REDL|REDU)
  • slit flatfield boundary, SLIT_FF_BNC_(REDL|REDU)
  • fibre flatfield common, FIB_FF_COM_(REDL|REDU)
  • fibre flatfield norm, FIB_FF_NOR_(REDL|REDU)
  • fibre flatfield norm sigma, FIB_FF_NSG_(REDL|REDU)

and the products that come out the other side? bestie, the glow-up is real ✨:

  • science fibre info table (FIB_SCI_INFO_TAB)
  • XB_SCI_RAW_(REDL|REDU)
  • ERR_XB_SCI_RAW_(REDL|REDU)
  • WXB_SCI_RAW_(REDL|REDU)
  • ERR_WXB_SCI_RAW_(REDL|REDU)
  • MWXB_SCI_RAW_(REDL|REDU)
  • ERR_MWXB_SCI_RAW_(REDL|REDU)
  • XB_SCI_(REDL|REDU)
  • ERR_XB_SCI_(REDL|REDU)
  • WXB_SCI_(REDL|REDU)
  • ERR_WXB_SCI_(REDL|REDU)
  • MWXB_SCI_(REDL|REDU)
  • ERR_MWXB_SCI_(REDL|REDU)

✨ OPTIONS ✨

okay this is the part you actually came for. buckle up, there's a lot, and every single one of them matters 💀

  • --bias_method <str> — the bias subtraction method (str; default: ´M´). the full name of this option for the EsoRex configuration file is flames_obs_scired.bias_method [default = M].
  • --bias_value <int> — the bias value, and this one only kicks in if bias_method = V (int; default: 200). the full name of this option for the EsoRex configuration file is flames_obs_scired.bias_value [default = 200].
  • --bkg_max_io_win <int> — background window number in each full inter order (int; default: 500). the full name of this option for the EsoRex configuration file is flames_obs_scired.bkg_max_io_win [default = 500].
  • --bkg_xy_win_sz_x <int> — x maximum size of each background window: (int; default: 6). the full name of this option for the EsoRex configuration file is flames_obs_scired.bkg_xy_win_sz_x [default = 6].
  • --bkg_xy_win_sz_y <int> — y maximum size of each background window: (int; default: 2). the full name of this option for the EsoRex configuration file is flames_obs_scired.bkg_xy_win_sz_y [default = 2].
  • --clean_tmp_products <bool> — input data format (bool; default: False). the full name of this option for the EsoRex configuration file is flames_obs_scired.clean_tmp_products [default = False].
  • --cor_def_off <float> — correlation center offset? (float; default: 0.0). the full name of this option for the EsoRex configuration file is flames_obs_scired.cor_def_off [default = 0.0].
  • --cor_def_pnt <int> — correlation sampling points? (int; default: 25). the full name of this option for the EsoRex configuration file is flames_obs_scired.cor_def_pnt [default = 25].
  • --cor_def_rng <float> — correlation range size? (float; default: 6.0). the full name of this option for the EsoRex configuration file is flames_obs_scired.cor_def_rng [default = 6.0].
  • --cor_max_fnd <str> — find correlation maximum? (str; default: ´Y´). the full name of this option for the EsoRex configuration file is flames_obs_scired.cor_max_fnd [default = Y].
  • --corvel_iter <int> — velocity correlation iteration number (SimCal) (int; default: 1). the full name of this option for the EsoRex configuration file is flames_obs_scired.corvel_iter [default = 1].
  • --cubify_sw <str> — cubify switch (str; default: ´N´). the full name of this option for the EsoRex configuration file is flames_obs_scired.cubify_sw [default = N].
  • --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].
  • --drs_base_name <str> — base name for science products (str; default: ´fxb´). the full name of this option for the EsoRex configuration file is flames_obs_scired.drs_base_name [default = fxb].
  • --drs_ext_w_siz <float> — integration window size good: 10 (if fibre deconvolution works fine) (float; default: 10.0). the full name of this option for the EsoRex configuration file is flames_obs_scired.drs_ext_w_siz [default = 10.0].
  • --drs_k_s_thre <float> — kappa sigma threshold (float; default: 10.0). the full name of this option for the EsoRex configuration file is flames_obs_scired.drs_k_s_thre [default = 10.0].
  • --drs_maxyshift <float> — half width of the interval to scan for correlation, when determining y shift (float; default: 3.0). the full name of this option for the EsoRex configuration file is flames_obs_scired.drs_maxyshift [default = 3.0].
  • --ext_method <str> — extraction method (str; default: ´opt´). the full name of this option for the EsoRex configuration file is flames_obs_scired.ext_method [default = opt].
  • --filt_sw <str> — filter switch (str; default: ´none´). the full name of this option for the EsoRex configuration file is flames_obs_scired.filt_sw [default = none].
  • --merge <str> — order merging method. if ´optimal´, the flux in the overlapping region is set to the (optimally computed, using the uncertainties) average of single order spectra. if ´sum´, the flux in the overlapping region is computed as the sum of the single order spectra. if flat-fielding is done, method ´optimal´ is recommended, otherwise ´sum´. (str; default: ´optimal´). the full name of this option for the EsoRex configuration file is flames_obs_scired.merge [default = optimal].
  • --merge_delt1 <float> — order merging left hand (short wavelength) cut. to reduce the amount of order overlapping regions we allow to cut short and long wavelength ranges. this may reduce the ripple possibly introduced by the order merging. suggested values are: 10 (W<=390), 12 (390<W<=437, 520<W<=564), 14 (437<W<=520, 564<W<860), 4 (W>=860) (float; default: -1.0). the full name of this option for the EsoRex configuration file is flames_obs_scired.merge_delt1 [default = -1.0].
  • --merge_delt2 <float> — order merging right hand (long wavelength) cut. to reduce the amount of order overlapping regions we allow to cut short and long wavelength ranges. this may reduce the ripple possibly introduced by the order merging. suggested values is 4 for W<860, else 0 (float; default: -1.0). the full name of this option for the EsoRex configuration file is flames_obs_scired.merge_delt2 [default = -1.0].
  • --pixel_thresh_max <int> — pixel saturation threshold max (int; default: 55000). the full name of this option for the EsoRex configuration file is flames_obs_scired.pixel_thresh_max [default = 55000].
  • --pixel_thresh_min <int> — pixel saturation threshold min (int; default: -20). the full name of this option for the EsoRex configuration file is flames_obs_scired.pixel_thresh_min [default = -20].
  • --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].
  • --rebin.scale <bool> — whether or not to multiply by the factor dx/dlambda (pixels per wavelength) during the rebinning to conserve the flux. this option is disabled as default because applying the flat field correction already ensures flux conservation. therefore this parameter should be TRUE (for response and science data) only if reduce.ffmethd = no. (bool; default: False). the full name of this option for the EsoRex configuration file is flames_obs_scired.rebin.scale [default = False].
  • --rebin.wavestep <float> — the bin size used for BLUE/REDL data (in w.l.u.) in wavelength space. if negative, a step size of 2/3 * ( average pixel size ) is used. (float; default: -1.0). the full name of this option for the EsoRex configuration file is flames_obs_scired.rebin.wavestep [default = -1.0].
  • --rebin.wavestep_redu <float> — the bin size used for REDU data (in w.l.u.) in wavelength space. if negative, a step size of 2/3 * ( average pixel size ) is used. (float; default: -1.0). the full name of this option for the EsoRex configuration file is flames_obs_scired.rebin.wavestep_redu [default = -1.0].
bestie, 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. 💖

part 1 done, and there's more coming so don't go anywhere 🦋

💖 SEE ALSO 💖

okay so like, the full documentation for the uves pipeline is out there as a PDF, and you can just grab it from this URL, bestie:

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

and if you want the big picture — like an overview over all the ESO pipelines that exist — the web page is literally right here:

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

for the basics on EsoRex</cvan> (the program itself), go read the esorex (1) man page. it's giving "how do I even run this" energy and it delivers.

and!! fun fact — you can call the pipelines straight from python using the python-cpl package. more deets here:

https://packages.python.org/python-cpl/index.html

and now, the recipe family roll call 🎀 — the other recipes of the uves pipeline are:

  • 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_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)

like, that's the whole squad 💅

✨ VERSION ✨

flames_obs_scired 6.1.8

periodt. that's the version. 💜

👑 AUTHOR 👑

Andrea Modigliani <cpl@eso.org> — yes, that's the icon who made this happen, show some respect 🫶

🐛 BUG REPORTS 🐛

if something's broken, do NOT just suffer in silence bestie, please report any problems to <cpl@eso.org>. or, if you'd rather, you can also send a report to the ESO User Support Department at <usd-help@eso.org>. they wanna hear from you, fr fr 🙈

📜 LICENSE 📜

so 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

ngl the all-caps warranty bit is the scary part but it's just standard GPL talk, it's not being mean to you 💀

okay that's literally the whole page, we did it 🎉 the footer situation is: this is flames_obs_scired version 6.1.8, page FLAMES_OBS_SCIRED(7) — so go forth, reduce some spectra, and slay ✨🦋💖

📦 where this page comes from