FORS_DETECT_SPECTRA(7)

πŸ“¦ version 5.5.7, in ubuntu jammy, ubuntu noble

πŸ’– fors_detect_spectra β€” FORS_DETECT_SPECTRA(7) πŸ’–

okay bestie, sit down, hydrate, and let me tell you about a little recipe called fors_detect_spectra from the FORS pipeline. she's giving ✨detective✨ energy and she is so good at her job πŸ•΅οΈβ™€οΈπŸ’…


🌸 NAME 🌸

fors_detect_spectra β€” detect MOS/MXU spectra on CCD. no cap, that's literally the whole vibe: finding spectra. πŸ”


✨ SYNOPSIS ✨

esorex fors_detect_spectra [OPTIONS] FILE.sof

πŸ¦‹ DESCRIPTION πŸ¦‹

so this recipe's whole thing is detecting and locating MOS/MXU slit spectra on the CCD, using a pattern-matching algorithm. iykyk. 🧠✨

your input spectral exposure has to contain spectra with the dispersion direction approximately horizontal, with blue on the left and red on the right. not negotiable, bestie, that's just how she rolls. 🌈

use recipe fors_wave_calib_lss for LSS data, or for MOS/MXU data where all slits have the same offset. πŸ‘‘

here's how the processing goes, one step at a time:

the rows of the input spectral exposure are processed separately, one by one. so:

  1. first, the background continuum is removed.
  2. second, a list of positions of reference line candidates is created. only peaks above a given threshold (specified by the parameter --peakdetection) are selected. so if it's too faint? not invited. πŸ™…β™€οΈ
  3. third, the pattern-matching task selects from the found peaks the ones corresponding to the reference lines, listed in the input line catalog, associating them to the appropriate wavelengths. the ensuing polynomial fit is used to locate the central wavelength of the applied grism along each image row. 🎯

the contributions from all rows form an image of the location of all spectra, that can be used as a starting point for the proper modeling of the optical and spectral distortions. for more details on this reduction strategy please refer to the FORS Pipeline UserΒ΄s Manual. πŸ“–

note that specifying an input GRISM_TABLE will set some of the recipe configuration parameters to default values valid for a particular grism. (the way she just knows what defaults you need… iconic.) πŸ’…

again, see the pipeline manual for more details. πŸ™ˆ

in the table below the MXU acronym can be alternatively read as MOS. cute, flexible, bilingual.

Input files: πŸ“₯

  • DO category: LAMP_UNBIAS_MXU β€” Type: Calib β€” Explanation: Bias subtracted arc β€” Required: Y
  • DO category: MASTER_LINECAT β€” Type: Calib β€” Explanation: Line catalog β€” Required: Y
  • DO category: GRISM_TABLE β€” Type: Calib β€” Explanation: Grism table β€” Required: .

Output files: πŸ“€

  • DO category: SLIT_MAP_MXU β€” Data type: FITS image β€” Explanation: Map of central wavelength on CCD
  • DO category: SLIT_LOCATION_DETECT_MXU β€” Data type: FITS table β€” Explanation: Slits positions on CCD
  • DO category: SPECTRA_DETECTION_MXU β€” Data type: FITS image β€” Explanation: Check of preliminary detection

πŸ’… OPTIONS πŸ’…

okay here come the knobs and dials. every single one, no skipping, we don't do that here. πŸŽ€

  • --dispersion <float> β€” expected spectral dispersion, in Angstrom/pixel. it's a float, and the default is 0.0. the full name of this option for the EsoRex configuration file is fors.fors_detect_spectra.dispersion [default = 0.0].
  • --peakdetection <float> β€” initial peak detection threshold, in ADU. float, default 0.0. the full name of this option for the EsoRex configuration file is fors.fors_detect_spectra.peakdetection [default = 0.0].
  • --wdegree <int> β€” degree of the wavelength calibration polynomial. int, default 0. the full name of this option for the EsoRex configuration file is fors.fors_detect_spectra.wdegree [default = 0].
  • --wradius <int> β€” search radius if iterating pattern-matching with the first-guess method. int, default 4. the full name of this option for the EsoRex configuration file is fors.fors_detect_spectra.wradius [default = 4].
  • --wreject <float> β€” rejection threshold in the dispersion relation fit, in pixels. float, default 0.7. the full name of this option for the EsoRex configuration file is fors.fors_detect_spectra.wreject [default = 0.7].
  • --wcolumn <str> β€” name of the line catalog table column with wavelengths. str, default Β΄WLENΒ΄. the full name of this option for the EsoRex configuration file is fors.fors_detect_spectra.wcolumn [default = WLEN].
  • --startwavelength <float> β€” start wavelength in spectral extraction. float, default 0.0. the full name of this option for the EsoRex configuration file is fors.fors_detect_spectra.startwavelength [default = 0.0].
  • --endwavelength <float> β€” end wavelength in spectral extraction. float, default 0.0. the full name of this option for the EsoRex configuration file is fors.fors_detect_spectra.endwavelength [default = 0.0].
  • --slit_ident <bool> β€” attempt slit identification for MOS or MXU. bool, default True. the full name of this option for the EsoRex configuration file is fors.fors_detect_spectra.slit_ident [default = True].
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. πŸ‘€

🌈 SEE ALSO 🌈

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

ftp://ftp.eso.org/pub/dfs/pipelines/fors/fors-pipeline-manual-4.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 fors pipeline are: fors_align_sky(7), fors_align_sky_lss(7), fors_bias(7), fors_calib(7), fors_config(7), fors_dark(7), fors_detect_objects(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) ✨ (the whole friend group, fr fr)


⭐ VERSION ⭐

fors_detect_spectra 5.5.7 β€” she's on version 5.5.7 and she's thriving. πŸ‘‘


πŸŽ€ AUTHOR πŸŽ€

Carlo Izzo <usd-help@eso.org> β€” thank you for your service, king πŸ«‘πŸ’–


😭 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 twice, they really want to hear from you, bestie πŸ“¬)


πŸ’œ 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!! that was fors_detect_spectra, version 5.5.7, manual page FORS_DETECT_SPECTRA(7) β€” go detect some spectra, you absolute main character. slay. periodt. πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈ
πŸ“¦ where this page comes from