VISIR_IMG_FF(7)

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

✨ VISIR_IMG_FF ✨

okay bestie, gather round 💖 this is the manual page for visir_img_ff (that's the (7) section one, from the visir recipes fam), and honestly? it's giving flat field realness. no cap.

🌸 NAME 🌸

visir_img_ff — the Flat field recipe. that's it. that's the name. she does flat fielding. 💅

🎀 SYNOPSIS 🎀

esorex visir_img_ff [OPTIONS] FILE.sof

like… that's the whole summoning ritual. esorex, the recipe name, some options if you're feeling spicy, and a sof file. iconic.

🦋 DESCRIPTION 🦋

so what does she actually do? this recipe computes the flatfield. periodt. that's the main character task right there.

now, the files you list inside your Set Of Frames (the sof-file, yes that's what sof stands for, iykyk) have to be tagged as one of these:

  • VISIR-flatfield-raw-file.fits IM_CAL_FLAT
  • VISIR-flatfield-raw-file.fits IM_TECH_FLAT
  • VISIR-flatfield-raw-file.fits SPEC_CAL_FLAT
  • VISIR-flatfield-raw-file.fits SPEC_TECH_FLAT

don't be out here tagging them wrong, the vibe check will fail 😭

and the matching primary product? it gets a FITS card called HIERARCH ESO PRO CATG with a value of IMG_FF or IMG_FF_TECH or SPEC_FF or SPEC_FF_TECH. like the tags map onto the products, cute right? 🫶

💅 OPTIONS 💅

only two, and honestly? low maintenance queen. both of these feed the bad pixel map thresholds.

  • --low <float> — the low threshold for the bad pixel map (float; default: 0.2). the full name of this option for the EsoRex configuration file is visir.visir_img_ff.low [default = 0.2].
  • --high <float> — the high threshold for the bad pixel map (float; default: 5.0). the full name of this option for the EsoRex configuration file is visir.visir_img_ff.high [default = 5.0].
heads up bestie: you can totally create a configuration file holding these options plus suitable default values. please refer to the details provided by the esorex --help command. go read it, it's free 💖

🌈 SEE ALSO 🌈

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

ftp://ftp.eso.org/pub/dfs/pipelines/visir/visir-pipeline-manual-1.4.pdf

an overview over the existing ESO pipelines lives at:

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

basic documentation about the EsoRex program can be found at the esorex(1) man page.

and — plot twist — you can call the pipelines from python using the python-cpl package. see https://packages.python.org/python-cpl/index.html for further info 🐍✨

the other recipes of the visir pipeline are, in all their glory:

whole friend group honestly 🥹

⭐ VERSION ⭐

visir_img_ff 4.4.2 — yes, we're on 4.4.2, she's stable and thriving.

👑 AUTHOR 👑

Lars Lundin <https://support.eso.org> — thank you for your service, king 🫡

🍓 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>. found a bug? don't suffer in silence, tell them, they're literally there for it 💜

📜 LICENSE 📜

this file is part of the VISIR Instrument Pipeline Copyright (C) 2004, 2005 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, and omg we made it 💖 this was visir_img_ff, version 4.4.2, dated the way this page is dated, straight out of the VISIR_IMG_FF(7) manual. go flat field something gorgeous. mwah 🎀✨

📦 where this page comes from