MUSE_QI_MASK(7)

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

💅 MUSE_QI_MASK(7) — muse recipes 💅

hiii bestie, welcome to MUSE_QI_MASK(7), one of the little recipe pages from the muse recipes collection. it's a baby recipe — technically not even in the main pipeline yet — but it's doing the most important job: making image masks for the quick image reconstruction. let's get into it 🫶

✨ NAME ✨

muse_qi_mask — create image masks for use with the quick image reconstruction. that's the whole vibe. masks. for QI. iconic.

🌈 SYNOPSIS 🌈

esorex muse_qi_mask [OPTIONS] FILE.sof

🦋 DESCRIPTION 🦋

okay so here's the tea. you take your trace calibration tables and your wavelength calibration tables — and there are 24 of each, one per IFU, because of course there are — and you use them to build wavelength maps. 🗺️

if your input data is binned, the wavelength maps get binned the exact same way (averaging of pixels, no fancy business). then those wavelength maps get thresholded so you end up with masks covering exactly the wavelength range you wanted. slay.

finally, the mask gets "untrimmed" — which is the technical way of saying empty regions get added back for the pre- and overscans. and it's done in a simple way, fr fr: it assumes quadrants of equal size, and pads 32 pixels on all quadrant edges. that's it, that's the math. 💅

🚨 not me dropping a warning in the middle of the description 🚨 note that this recipe is not part of the main MUSE pipeline — it's meant to be used in the integration phase to create image masks until the system is fully qualified. so it does only minimal error checking. it is not out here catching your mistakes for you, bestie. check your own stuff. 😭

🎀 OPTIONS 🎀

  • --nifu <int> — which IFU to handle. if you set it to 0, all IFUs are processed serially, and honestly? that's the recommendation for this recipe, because only then do all the extensions end up in the same output file. (type: int; default: 0). the full name of this option for the EsoRex configuration file is muse.muse_qi_mask.nifu [default = 0].
💡 little side note, bestie: 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. go look, it's right there. 🫶

🌸 SEE ALSO 🌸

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

ftp://ftp.eso.org/pub/dfs/pipelines/muse/muse-pipeline-cookbook-2.8.7.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.

and the other recipes of the muse pipeline, aka the whole friend group 👑:

⭐ VERSION ⭐

muse_qi_mask 2.8.7

💜 AUTHOR 💜

Peter Weilbacher <https://support.eso.org> — thank you king, we owe you 🫡

🙈 BUG REPORTS 🙈

please report any problems to https://support.eso.org. alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>. they're literally so nice, don't be shy, tell them what broke. 💌

👑 LICENSE 👑

this file is part of the MUSE Instrument Pipeline Copyright (C) 2005, 2019 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

okay that's the whole page, bestie, you ate it 🍓✨ and if you're ever wondering where this came from: it's muse_qi_mask, version 2.8.7, living its best life as MUSE_QI_MASK(7). go make some masks, no cap. 💖🦋💅

📦 where this page comes from