GIWAVECALIBRATION(7)

📦

version 2.16.10 · 2 versions

2.16.10 · debian bookworm, ubuntu noble (latest)
2.16.8 · ubuntu jammy

💖 GIWAVECALIBRATION(7) — giraf recipes 💖

okay bestie, welcome to the group chat. this is the giwavecalibration recipe from the giraf family, hanging out in section 7 of the manual. it's giving spectral detective energy and we're gonna read every single line together, no skipping. 🦋

🌸 NAME 🌸

giwavecalibration — Compute dispersion solution from an arc-lamp spectrum.

like. that's the whole vibe. arc lamp in, dispersion solution out. ✨

🎀 SYNOPSIS 🎀

esorex giwavecalibration [OPTIONS] FILE.sof

so you literally just run esorex, hand it giwavecalibration, sprinkle whatever [OPTIONS] you want on top, and pass it your FILE.sof at the end. periodt. 💅

🦋 DESCRIPTION 🦋

For detailed information please refer to the GIRAFFE pipeline user manual.

It is available at http://www.eso.org/pipelines.

no cap, the real lore lives in that manual. this page is the recipe card, that manual is the whole cookbook. 🍓

✨ OPTIONS ✨

okay so here's the thing, there are SO MANY of these and they all live in groups. every single one of them also has a "full name" for the EsoRex configuration file, and bestie, I'm telling you all of them. let's go. 🔥

💜 bias removal era

--remove-bias <bool> — Enable bias removal (bool; default: True). The full name of this option for the EsoRex configuration file is giraffe.biasremoval.remove [default = True].
--bsremove-method <str> — Bias removal method (str; default: ´PROFILE´). The full name of this option for the EsoRex configuration file is giraffe.biasremoval.method [default = PROFILE].
--bsremove-areas <str> — Bias areas to use (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: 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 [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 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 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].

🌈 extraction era

--extr-method <str> — Extraction method: ´SUM´, ´HORNE´ or ´OPTIMAL´ (str; default: ´SUM´). The full name of this option for the EsoRex configuration file is giraffe.extraction.method [default = SUM].
--extr-ron <float> — New bias sigma (RON) value for bias and dark corrected image (float; default: -1.0). The full name of this option for the EsoRex configuration file is giraffe.extraction.ron [default = -1.0].
--extr-psfmodel <str> — PSF profile model: `psfexp´, `psfexp2´ (str; default: ´psfexp2´). The full name of this option for the EsoRex configuration file is giraffe.extraction.psf.model [default = psfexp2].
--extr-psfsigma <float> — Sigma clippging threshold used for rejecting data points during PSF fitting (Horne´s sigma). It is used to reject bad pixels and cosmics. (float; default: 7.0). The full name of this option for the EsoRex configuration file is giraffe.extraction.psf.sigma [default = 7.0].
--extr-psfniter <int> — Maximum number of iterations used for fitting the PSF profile. (int; default: 2). The full name of this option for the EsoRex configuration file is giraffe.extraction.psf.iterations [default = 2].
--extr-hewidth <int> — Horne extraction method: Number of extra pixels added to the fiber half-width. (int; default: 2). The full name of this option for the EsoRex configuration file is giraffe.extraction.horne.extrawidth [default = 2].
--extr-hmingood <int> — Horne extraction method: Minimum number of points used for the profile fit. It sets the lower limit of data points for the pixel rejection. (int; default: 3). The full name of this option for the EsoRex configuration file is giraffe.extraction.horne.mingood [default = 3].
--extr-omfrac <float> — Optimal extraction method: Minimum fraction of the data points used for fitting the fiber profiles. It sets the lower limit for the pixel rejection. (float; default: 0.9). The full name of this option for the EsoRex configuration file is giraffe.extraction.optimal.fraction [default = 0.9].
--extr-owfactor <float> — Optimal extraction method: Factor by which the fiber PSF half width is multiplied. Adjacent spectra within this area are assumed to affect the spectrum being extracted. (float; default: 3.0). The full name of this option for the EsoRex configuration file is giraffe.extraction.optimal.wfactor [default = 3.0].
--extr-obkgorder <int> — Optimal extraction method: Order of the polynomial background model, which is fitted for each wavelength bin along the spatial direction. (int; default: 2). The full name of this option for the EsoRex configuration file is giraffe.extraction.optimal.bkgorder [default = 2].

⭐ wavelength calibration era ⭐

--wcal-lswidth <str> — List of window widths [pxl] used for line detection and fit (e.g. ´60,40,15´). (str; default: ´10,10,10,10,10´). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.widths [default = 10,10,10,10,10].
--wcal-lssep <float> — Factor used to compute the minimum line separation from the window width. (float; default: 0.9). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.separation [default = 0.9].
--wcal-lsfxratio <float> — Selects only lines whose neighbours have a relative intensity less than 1. / fluxratio. (float; default: 50.0). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.fluxratio [default = 50.0].
--wcal-lsbright <float> — Selects lines having an intensity greater or equal to the given intensity. (float; default: 0.0). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.brightness [default = 0.0].
--wcal-lscount <int> — Sets the minimum number of lines to select; selected are lines with the highest nominal intensity. A value of 0 turns this selection off. If the value is less than 0 the selection is skipped if the line list does not contain enough lines. (int; default: -80). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.count [default = -80].
--wcal-lswrange <str> — Selects only lines within the given wavelength range [nm]. (str; default: ´0.,0.´). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.wrange [default = 0.,0.].
--wcal-lfmodel <str> — Line profile model. (str; default: ´psfexp´). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.model [default = psfexp].
--wcal-lfres <str> — Use optical model residuals for line detection. (str; default: ´auto´). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.residuals [default = auto].
--wcal-lfthreshold <float> — Line detection threshold during the line fitting (multiple of bias sigma) (float; default: 1.0). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.threshold [default = 1.0].
--wcal-lfoffset <float> — Maximum allowed difference between the fitted and raw line peak position. (float; default: 10.0). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.offset [default = 10.0].
--wcal-lfniter <int> — Line detection fit maximum number of iterations. (int; default: 50). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.iterations [default = 50].
--wcal-lfntest <int> — Line detection fit maximum number of tests. (int; default: 7). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.tests [default = 7].
--wcal-lfdchisq <float> — Line detection fit minimum chi-square difference. (float; default: 0.0001). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.dchisquare [default = 0.0001].
--wcal-lfreswid <float> — Line width/resolution width factor. (float; default: 0.5). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.rwidthratio [default = 0.5].
--wcal-lfexpwid <float> — Exponential line profile exponent; it will not be fitted if it is larger than 0. (float; default: -3.0). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.line.exponent [default = -3.0].
--wcal-soffset <str> — Initial slit position offsets along the x and y direction and rotation angle. (str; default: ´setup´). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.slit.offset [default = setup].
--wcal-ommodel <str> — Optical model. (str; default: ´xoptmod2´). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.opt.model [default = xoptmod2].
--wcal-omdir <int> — Dispersion direction flag. (int; default: 1). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.opt.direction [default = 1].
--wcal-omsol <bool> — Controls optical model parameter fitting. (bool; default: True). The full name of this option for the EsoRex configuration file is giraffe.wlcalibration.opt.solution [default = True].

and bestie… we are SO not done yet. part 2 is coming, keep scrolling, don't you dare close the tab. 🫶

--wcal-omflags <str> — the list of flags that decide which parameters are free when we fit the optical model, bestie. Possible values are fcoll, gcam, theta, sdx, sdy, sphi (str; default: sdx,sdy,sphi). Full name for the EsoRex config file: giraffe.wlcalibration.opt.flags [default = sdx,sdy,sphi].
--wcal-omsslits <bool> — controls whether subslit geometry gets used in the optical model fit; subslits are used when it's set to true (bool; default: False). Full name for the EsoRex config file: giraffe.wlcalibration.opt.subslits [default = False].
--wcal-omniter <int> — max number of iterations for the optical model fit (int; default: 50). Full name for the EsoRex config file: giraffe.wlcalibration.opt.iterations [default = 50].
--wcal-omntest <int> — max number of tests for the optical model fit (int; default: 7). Full name for the EsoRex config file: giraffe.wlcalibration.opt.tests [default = 7].
--wcal-omdchisq <float> — minimum chi-square difference for the optical model fit (float; default: 0.0001). Full name for the EsoRex config file: giraffe.wlcalibration.opt.dchisquare [default = 0.0001].
--wcal-xwsigma <float> — sigma clipping factor for the PSF width fit (float; default: 1.25). Full name for the EsoRex config file: giraffe.wlcalibration.psf.sigma [default = 1.25].
--wcal-xwniter <int> — max number of iterations for the PSF width fit sigma clipping (int; default: 10). Full name for the EsoRex config file: giraffe.wlcalibration.psf.iterations [default = 10].
--wcal-xwmfrac <float> — minimum fraction of points accepted/total for the PSF width fit sigma clipping (float; default: 0.9). Full name for the EsoRex config file: giraffe.wlcalibration.psf.fraction [default = 0.9].
--wcal-xworder <str> — the X and Y polynomial orders for the PSF x-width Chebyshev fit (str; default: 2,2). Full name for the EsoRex config file: giraffe.wlcalibration.psf.order [default = 2,2].
--wcal-wssigma <float> — sigma clipping factor for the Chebyshev correction (float; default: 150.0). Full name for the EsoRex config file: giraffe.wlcalibration.wsol.sigma [default = 150.0].
--wcal-wsniter <int> — max number of iterations for the Chebyshev correction sigma clipping (int; default: 10). Full name for the EsoRex config file: giraffe.wlcalibration.wsol.iterations [default = 10].
--wcal-wsmfrac <float> — minimum fraction of points accepted/total for the Chebyshev correction sigma clipping (float; default: 0.9). Full name for the EsoRex config file: giraffe.wlcalibration.wsol.fraction [default = 0.9].
--wcal-wsorder <str> — the X and Y polynomial orders for the wavelength solution Chebyshev correction (str; default: 6,4). Full name for the EsoRex config file: giraffe.wlcalibration.wsol.order [default = 6,4].
--wcal-rebin <bool> — rebin the extracted arc-lamp spectra? (bool; default: True). Full name for the EsoRex config file: giraffe.wcal.rebin [default = True].
--rbin-method <str> — which method to use: linear or spline (str; default: linear). Full name for the EsoRex config file: giraffe.rebinning.method [default = linear].
--rbin-xresid <bool> — do we use x residuals during rebinning? true/false (bool; default: True). Full name for the EsoRex config file: giraffe.rebinning.xresiduals [default = True].
--rbin-lstep <float> — the lambda step size, only used when the scaling method is linear (float; default: 0.005). Full name for the EsoRex config file: giraffe.rebinning.lstep [default = 0.005].
--rbin-scmethod <str> — scaling method: log or linear (str; default: linear). Full name for the EsoRex config file: giraffe.rebinning.scalemethod [default = linear].
--rbin-size <int> — size of the output rebinned spectra; 0 means "calculate the size from the wavelength range and lambda stepsize" (int; default: 0). Full name for the EsoRex config file: giraffe.rebinning.size [default = 0].
--rbin-range <str> — the rebinning range: setup or common (str; default: setup). Full name for the EsoRex config file: giraffe.rebinning.range [default = setup].
--wcal-slit <bool> — controls the slit geometry calibration (bool; default: False). Full name for the EsoRex config file: giraffe.wcal.slitgeometry [default = False].
--scal-cniter <int> — max number of iterations for the slit geometry calibration (int; default: 1). Full name for the EsoRex config file: giraffe.sgcalibration.iterations [default = 1].
--scal-zmax <float> — maximum allowed pixel value. To actually do anything it has to be bigger than 0. (float; default: 10000.0). Full name for the EsoRex config file: giraffe.sgcalibration.zmax [default = 10000.0].
--scal-cstep <float> — cross-correlation step (float; default: -0.005). Full name for the EsoRex config file: giraffe.sgcalibration.cc.step [default = -0.005].
--scal-cdomain <str> — restricts the cross-correlation to the given domain (str; default: 0.,0.). Full name for the EsoRex config file: giraffe.sgcalibration.cc.domain [default = 0.,0.].
--scal-rvlimits <str> — delta RV limits of the cross-correlation window, in km/s (str; default: -200.,200.). Full name for the EsoRex config file: giraffe.sgcalibration.rv.limits [default = -200.,200.].
--scal-rvniter <int> — max number of iterations used for the RV determination (int; default: 3). Full name for the EsoRex config file: giraffe.sgcalibration.rv.iterations [default = 3].
--scal-rvwfactor <float> — data window width factor. The FWHM times this value gives you the window width (float; default: 1.5). Full name for the EsoRex config file: giraffe.sgcalibration.rv.wfactor [default = 1.5].
--scal-pfniter <int> — max number of iterations for the peak model fit (int; default: 50). Full name for the EsoRex config file: giraffe.sgcalibration.peak.iterations [default = 50].
--scal-pfntest <int> — max number of tests for the cross-correlation peak fit (int; default: 7). Full name for the EsoRex config file: giraffe.sgcalibration.peak.tests [default = 7].
--scal-pfdchisq <float> — minimum chi-square difference for the cross-correlation peak fit (float; default: 0.0001). Full name for the EsoRex config file: giraffe.sgcalibration.peak.dchisquare [default = 0.0001].

Okay so heads up, bestie 💜 — you can absolutely make a configuration file holding all these options, plus suitable default values. Just go check the details that the 'esorex --help' command gives you. No cap.

💫 SEE ALSO 💫

The full documentation for the giraf pipeline can be downloaded as a PDF file using this URL, and yes it's an ftp link, we love a retro moment:

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

An overview over the existing ESO pipelines lives on this web page: https://www.eso.org/sci/software/pipelines/.

Basic documentation about the EsoRex program? That's 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 more info.

The other recipes of the giraf pipeline are giframestack(7), gimasterbias(7), gimasterdark(7), gimasterflat(7), giscience(7), gistandard(7). The whole friend group, iconic 🌈.

🎀 VERSION 🎀

giwavecalibration 2.16.10 — the moment, the legend.

👑 AUTHOR 👑

Giraffe Pipeline <https://support.eso.org/> — the ones who made it happen, periodt.

😭 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 genuinely want to hear from you, fr fr.

⚖️ LICENSE ⚖️

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, we ate and left no crumbs 💅✨

This was giwavecalibration version 2.16.10, the GIWAVECALIBRATION(7) manual page. Go calibrate some wavelengths, you main character 🦋🌸

📦 where this page comes from

debian bookworm: cpl-plugin-giraf-doc 2.16.10+dfsg-1 · GPL-v2+
ubuntu noble: cpl-plugin-giraf-doc 2.16.10+dfsg-1build3 · GPL-v2+
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-18: a language model's rewrite of the original, under its terms