FORS_DETECT_OBJECTS(7)

✨ FORS_DETECT_OBJECTS ✨

okay bestie, welcome to FORS_DETECT_OBJECTS(7) — the fors recipe that goes looking for your science objects in slit spectra 🕵️‍♀️💖 it's manual page 7 in the fors recipe crew, and honestly? it's giving "find the stars in the crowd" and we're obsessed.

---

🌸 NAME 🌸

fors_detect_objects — detect objects in slit spectra 🔭✨

---

🎀 SYNOPSIS 🎀

esorex fors_detect_objects [OPTIONS] FILE.sof

like, that's the whole vibe. you pass it a .sof file and it does the thing 💅

---

🦋 DESCRIPTION 🦋

so this recipe is the one that detects scientific object spectra sitting on a resampled image that came out of the fors_resample recipe. if you want the full lore, the FORS Pipeline User´s Manual has all the details on how object detection actually works — go read it, fr fr 📖

real talk: in the table below, the MXU acronym can also be read as MOS and LSS, and SCI can be read as STD. yes, it's a choose-your-own-acronym situation. iconic 💀

🌈 Input files

• DO category: MAPPED_SCI_MXU — Type: Calib — Explanation: Resampled slit spectra — Required: Y ✅
• DO category: SLIT_LOCATION_MXU — Type: Calib — Explanation: Slit location on image — Required: Y ✅

🌟 Output files

• DO category: OBJECT_TABLE_SCI_MXU — Data type: FITS table — Explanation: Object positions in slit spectra 📊

---

💅 OPTIONS 💅

• --slit_margin <int> — how many pixels to exclude at each slit when it's doing object detection and extraction. it's an int, and the default is 3. the full name of this option for the EsoRex configuration file is fors.fors_detect_objects.slit_margin [default = 3]. 🚧
• --ext_radius <int> — the maximum extraction radius for detected objects, measured in pixels. it's an int, default 6. the full name of this option for the EsoRex configuration file is fors.fors_detect_objects.ext_radius [default = 6]. 🔵
• --cont_radius <int> — the minimum distance at which two objects of equal luminosity stop contaminating each other, in pixels. it's an int, default 0. the full name of this option for the EsoRex configuration file is fors.fors_detect_objects.cont_radius [default = 0]. 📏

heads up bestie: you can make a configuration file with these options in it, along with some suitable default values. just check the details that esorex --help gives you. 🫶

---

👑 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 at:

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

basic documentation about the EsoRex program is in the esorex (1) man page. 📚

also!! you can call the pipelines from python using the python-cpl package. see https://packages.python.org/python-cpl/index.html for further information. 🐍✨

and the other recipes of the fors pipeline are, in all their glory: fors_align_sky(7), fors_align_sky_lss(7), fors_bias(7), fors_calib(7), fors_config(7), fors_dark(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). the whole friend group 💖

---

⭐ VERSION ⭐

fors_detect_objects 5.5.7

---

🧚 AUTHOR 🧚

Carlo Izzo <usd-help@eso.org> — thank you for your service 🫡

---

🙈 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>. they're nice, promise 🤝

---

💜 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. ⚠️ (yes that's the dramatic all-caps part, it means it, no cap)

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 page, bestie!! 🌈 this whole thing is from the fors_detect_objects 5.5.7 era, dated back to those classic FORS_DETECT_OBJECTS(7) days — go detect some objects and slay 💅✨