FORS_CONFIG(7)

📦 version 5.5.7, in ubuntu jammy, ubuntu noble

💖 FORS_CONFIG(7) 💖

okay bestie, welcome to fors_config — this is a page from the fors recipes manual (section 7, if you're keeping score), and honestly? it's a whole vibe. it's short, it's sweet, it's giving "little recipe that does one thing extremely well." let's get into it 🦋

✨ NAME ✨

fors_config — the creation of FORS recipes configuration tables. yes, that's the whole name section. slay 💅

🌸 SYNOPSIS 🌸

esorex fors_config [OPTIONS] FILE.sof

💜 DESCRIPTION 💜

so here's the tea, bestie: this recipe is the one that makes the so-called GRISM_TABLE. and what is that? it's a table holding all the FORS spectral pipeline configuration parameters that relate to one specific grism. the whole point is that you can hand each specific instrument mode its own set of appropriate defaults for the recipe parameters. lowkey genius tbh 👑

now, the way it works is very "copy-paste but make it FITS": the values you assign to each input parameter of fors_config are simply copied into a FITS table. that table has one row, and as many columns as there are input parameters — and each column gets the same name and the same type as its parameter. no cap.

but wait, there are three little exceptions that do NOT become table columns: instrument, grism, and id. those three get written into the descriptor header keywords instead:

  • INSTRUME
  • ESO INS GRIS1 NAME
  • ESO INS GRIS1 ID

...which the automatic pipeline then uses for appropriate data association. periodt.

Input files: none. nothing. zero. the void. 🙈

  DO category:               Type:       Explanation:         Required:
Output files:

  DO category:               Data type:  Explanation:
  GRISM_TABLE                FITS table  Recipe configuration parameters

🔥 OPTIONS 🔥

every single one, no skipping, let's go 💖

  • --dispersion <float> — expected spectral dispersion, measured in Angstrom/pixel (float; default: 0.0). the full name of this option for the EsoRex configuration file is fors.fors_config.dispersion [default = 0.0].
  • --peakdetection <float> — the peak detection threshold, in ADU (float; default: 250.0). the full name of this option for the EsoRex configuration file is fors.fors_config.peakdetection [default = 250.0].
  • --wdegree <int> — degree of the wavelength calibration polynomial (int; default: 4). the full name of this option for the EsoRex configuration file is fors.fors_config.wdegree [default = 4].
  • --cdegree <int> — degree of the spectral curvature polynomial (int; default: 4). the full name of this option for the EsoRex configuration file is fors.fors_config.cdegree [default = 4].
  • --startwavelength <float> — the start wavelength used in spectral extraction (float; default: 0.0). the full name of this option for the EsoRex configuration file is fors.fors_config.startwavelength [default = 0.0].
  • --endwavelength <float> — the end wavelength used in spectral extraction (float; default: 0.0). the full name of this option for the EsoRex configuration file is fors.fors_config.endwavelength [default = 0.0].
  • --instrument <str> — name of instrument (str; default: ´0´). the full name of this option for the EsoRex configuration file is fors.fors_config.instrument [default = 0].
  • --grism <str> — name of grism (str; default: ´0´). the full name of this option for the EsoRex configuration file is fors.fors_config.grism [default = 0].
  • --grism_id <str> — grism ID (str; default: ´0´). the full name of this option for the EsoRex configuration file is fors.fors_config.grism_id [default = 0].
  • --filter <str> — name of filter (str; default: ´0´). the full name of this option for the EsoRex configuration file is fors.fors_config.filter [default = 0].
  • --filter_id <str> — filter ID (str; default: ´0´). the full name of this option for the EsoRex configuration file is fors.fors_config.filter_id [default = 0].
💡 btw bestie, it is possible to create a configuration file containing these options, along with suitable default values. just please refer to the details provided by the esorex --help command. iykyk 🫶

🦋 SEE ALSO 🦋

the full documentation for the fors pipeline can be downloaded as a PDF file using this URL:

ftp://ftp.eso.org/pub/dfs/pipelines/fors/fors-pipeline-manual-4.9.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 can be found at the esorex (1) man page.

and yes, 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 fors pipeline are — ok deep breath, it's a long list, but every single one matters 🌈:

fors_align_sky(7), fors_align_sky_lss(7), fors_bias(7), fors_calib(7), fors_dark(7), fors_detect_objects(7), fors_detect_spectra(7), fors_extract(7), fors_extract_objects(7), fors_extract_slits(7), fors_flatfield(7), fors_img_science(7), fors_img_screen_flat(7), fors_img_sky_flat(7), fors_normalise_flat(7), fors_photometry(7), fors_pmos_calib(7), fors_pmos_extract(7), fors_pmos_science(7), fors_remove_bias(7), fors_resample(7), fors_science(7), fors_spec_mflat(7), fors_subtract_sky(7), fors_subtract_sky_lss(7), fors_sumflux(7), fors_trace_flat(7), fors_wave_calib(7), fors_wave_calib_lss(7), fors_zeropoint(7)

⭐ VERSION ⭐

fors_config 5.5.7

🎀 AUTHOR 🎀

Carlo Izzo <usd-help@eso.org> — icon behavior, honestly 👑

💀 BUG REPORTS 💀

please report any problems to usd-help@eso.org. alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>. (yes, same address both times. they really want those bug reports fr fr 😭)

🌸 LICENSE 🌸

this file is currently part of the FORS Instrument Pipeline Copyright (C) 2002-2010 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 was fors_config, version 5.5.7, from the FORS_CONFIG(7) man page — go make some grism tables, you absolute main character 🧚✨

📦 where this page comes from