GIMASTERDARK(7)

💅 GIMASTERDARK — the giraf recipes manual, bestie edition ✨

okay so welcome to gimasterdark(7), one of the iconic little recipe pages from the giraf pipeline family 🎀. grab a snack, we're building a master dark 🍓

---

🌙 NAME 🌙

gimasterdark — creates a master dark image from a set of raw dark frames. that's it. that's the whole job. and it slays at it 💅

---

✨ SYNOPSIS ✨

esorex gimasterdark [OPTIONS] FILE.sof

literally that's the entire summoning ritual. a .sof file and some options, and boom 🦋

---

💖 DESCRIPTION 💖

ngl, for the detailed lore you gotta go read the GIRAFFE pipeline user manual. it's giving ✨required reading✨.

it lives at http://www.eso.org/pipelines — go get it, bestie 🫶

---

🔥 OPTIONS 🔥

okay this is the part where I hold your hand through every single flag, no skips, no skimping, we're doing all of them 💜

• --stack-method <str> — the stacking method, choose your fighter: average, median, minmax or ksigma (it's a str, default is median). the full name of this option for the EsoRex configuration file is giraffe.stacking.method [default = median]. 👑
• --stack-ksigmalow <float> — lower threshold multiplier, only for the ksigma method (float, default 5.0). the full name of this option for the EsoRex configuration file is giraffe.stacking.ksigma.low [default = 5.0].
• --stack-ksigmahigh <float> — upper threshold multiplier, again only for ksigma (float, default 5.0). the full name of this option for the EsoRex configuration file is giraffe.stacking.ksigma.high [default = 5.0].
• --stack-minreject <int> — minimum rejection level, for the minmax method (int, default 1). the full name of this option for the EsoRex configuration file is giraffe.stacking.minmax.minimum [default = 1].
• --stack-maxreject <int> — maximum rejection level, also minmax (int, default 1). the full name of this option for the EsoRex configuration file is giraffe.stacking.minmax.maximum [default = 1].
• --remove-bias <bool> — turns bias removal on or off (bool, default True). the full name of this option for the EsoRex configuration file is giraffe.biasremoval.remove [default = True].
• --bsremove-method <str> — which bias removal method to use (str, default PROFILE). the full name of this option for the EsoRex configuration file is giraffe.biasremoval.method [default = PROFILE].
• --bsremove-areas <str> — the bias areas to use, formatted as Xl0:Xr0:Yl0:Yr0, ... ,Xln:Xrn:Yln:Yrn (str, default 5:40:0:4095). the full name of this option for the EsoRex configuration file is giraffe.biasremoval.areas [default = 5:40:0:4095].
• --bsremove-sigma <float> — sigma clipping: the sigma threshold factor (float, default 2.5). the full name of this option for the EsoRex configuration file is giraffe.biasremoval.sigma [default = 2.5].
• --bsremove-niter <int> — sigma clipping: maximum number of iterations (int, default 5). the full name of this option for the EsoRex configuration file is giraffe.biasremoval.iterations [default = 5].
• --bsremove-mfrac <float> — sigma clipping: minimum fraction of points accepted/total, range [0.0..1.0] (float, default 0.8). the full name of this option for the EsoRex configuration file is giraffe.biasremoval.fraction [default = 0.8].
• --bsremove-xorder <int> — order of the X polynomial fit, CURVE method only (int, default 1). the full name of this option for the EsoRex configuration file is giraffe.biasremoval.xorder [default = 1].
• --bsremove-yorder <int> — order of the Y polynomial fit, CURVE method only (int, default 1). the full name of this option for the EsoRex configuration file is giraffe.biasremoval.yorder [default = 1].
• --bsremove-xstep <int> — sampling step along X, CURVE method only (int, default 1). the full name of this option for the EsoRex configuration file is giraffe.biasremoval.xstep [default = 1].
• --bsremove-ystep <int> — sampling step along Y, CURVE method only (int, default 1). the full name of this option for the EsoRex configuration file is giraffe.biasremoval.ystep [default = 1].

💡 fun fact: you can make a whole configuration file holding these options plus suitable default values. want the deets? run esorex --help and let it spill the tea 🍵

---

🌈 SEE ALSO 🌈

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

ftp://ftp.eso.org/pub/dfs/pipelines/giraffe/giraf-pipeline-manual-2.11.pdf

an overview over the existing ESO pipelines lives here: https://www.eso.org/sci/software/pipelines/ 👑

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

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.

the other recipes of the giraf pipeline — the whole squad, periodt — are giframestack(7), gimasterbias(7), gimasterflat(7), giscience(7), gistandard(7), giwavecalibration(7) 💖

---

⭐ VERSION ⭐

gimasterdark 2.16.10 — yes she has a version number and yes it's iconic

---

👑 AUTHOR 👑

Giraffe Pipeline <https://support.eso.org/> — mwah, thanks for your service 🫶

---

😭 BUG REPORTS 😭

found a problem? please report it to https://support.eso.org/. alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>. do it, they're nice, I promise 💜

---

📜 LICENSE 📜

this file is part of the GIRAFFE Instrument Pipeline Copyright (C) 2002-2014 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

⚠️ no cap, that warranty disclaimer is doing a LOT of heavy lifting. read it. respect it.

---

okay that's the whole page, and to close us out: this was gimasterdark 2.16.10 from the giraf recipes, dated with the version 2.16.10 — love her, know her, run her responsibly 🎀✨💅