FORS_EXTRACT_OBJECTS(7)

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

πŸ’– fors_extract_objects(7) β€” a fors recipe, bestie edition πŸ’–

okay so welcome to the fors recipes corner of the manual, and today's main character is fors_extract_objects. manual section 7, very demure, very pipeline. let's get into it 🫢


✨ NAME ✨

fors_extract_objects β€” extract objects in slit spectra πŸ¦‹


🌸 SYNOPSIS 🌸

esorex fors_extract_objects [OPTIONS] FILE.sof

that's it. that's the whole vibe. an esorex call, some options if you're feeling fancy, and a .sof file. periodt πŸ’…


πŸŽ€ DESCRIPTION πŸŽ€

okay so picture this: this recipe pulls the spectra of your scientific objects out of a resampled image β€” and that resampled image comes from the recipe fors_resample. and where does it grab them from? from the positions listed in the object table</>, which is the lil gift that recipe fors_detect_objects left for you. it's giving teamwork, fr fr. if you want the whole deep lore on object extraction, go read the FORS Pipeline UserΒ΄s Manual, it's all in there πŸ“–

also, tiny legend note so nobody gets confused: in the table below, MXU can also be read as MOS or LSS, and SCI can also be read as STD. same energy, different letters, iykyk πŸ’«

🧚 Input files (what you gotta feed it)

  • MAPPED_SCI_MXU β€” Type: Calib β€” Resampled slit spectra β€” Required: Y
  • MAPPED_SKY_SCI_MXU β€” Type: Calib β€” Resampled sky spectra β€” Required: Y
  • OBJECT_TABLE_SCI_MXU β€” Type: Calib β€” Object table β€” Required: Y

all three are required, no skipping, no "i'll do it later", the recipe is not playing 😭

🌈 Output files (what you get back, and it ATE)

  • REDUCED_SCI_MXU β€” Data type: FITS image β€” Extracted object spectra
  • REDUCED_SKY_SCI_MXU β€” Data type: FITS image β€” Extracted sky spectra
  • REDUCED_ERROR_SCI_MXU β€” Data type: FITS image β€” Error on extracted spectra

three whole FITS images. iconic. we love a productive recipe πŸ‘‘


πŸ’… OPTIONS πŸ’…

  • --ext_mode <int> β€” the object extraction method, bestie. 0 = aperture, 1 = Horne optimal extraction. it's an int, and the default is 1 (so optimal extraction unless you say otherwise, we're fancy like that). the full name of this option for the EsoRex configuration file is fors.fors_extract_objects.ext_mode [default = 1]. ✨
heads up: you can make a configuration file holding these options with cute little default values baked in. for the details on how, go check what esorex --help tells you. πŸ“

πŸ”₯ SEE ALSO πŸ”₯

the full documentation for the fors pipeline is out here living its best life as a downloadable PDF at this URL:

ftp://ftp.eso.org/pub/dfs/pipelines/fors/fors-pipeline-manual-4.9.pdf

want the big picture of all the ESO pipelines in existence? the web page is right here:

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

basic documentation about the EsoRex program itself? that's the esorex(1) man page, go say hi 🫢

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 information. python girlies rise 🌸

the other recipes of the fors pipeline, aka the rest of the friend group: 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_detect_spectra(7), fors_extract(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)

that's the whole squad. no cap. πŸ’œ


⭐ VERSION ⭐

fors_extract_objects 5.5.7


πŸ‘‘ AUTHOR πŸ‘‘

Carlo Izzo <usd-help@eso.org>


πŸ™ˆ 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 want to hear from you, fr fr, don't be shy 🫢


πŸ“œ 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_extract_objects, version 5.5.7, from the fors recipes manual section 7 β€” thank you for coming to my ted talk, go extract some objects, slay, and remember: sky spectra don't extract themselves πŸ’–πŸ’…πŸ¦‹

πŸ“¦ where this page comes from