MUSE_EXP_ALIGN(7)

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

✨ MUSE_EXP_ALIGN ✨

okay bestie, welcome to the muse recipes corner of the manual 💖 this is MUSE_EXP_ALIGN(7) and it's genuinely one of the more satisfying little recipes, so let's go 🫶

🌸 NAME 🌸

muse_exp_align — build a coordinate offset table that you then use to line up (align) your exposures when you combine them. it's giving "matchmaker for your frames" 💅

🦋 SYNOPSIS 🦋

esorex muse_exp_align [OPTIONS] FILE.sof

💫 DESCRIPTION 💫

so here's the vibe: this recipe computes the coordinate offset of every input field-of-view image, measured relative to a reference. that resulting list of coordinate offsets is exactly what you hand to muse_exp_combine as the field coordinate offsets, so your exposures actually line up properly when they get combined. no cap.

now, where do the source positions come from that feed this field-offset math? by default, the recipe detects point sources in each of the input images. but — plot twist — if you override the source detection and you've got an input source list available for each input field-of-view image, then those input source positions are what get used to calculate the field offsets. either way, offsets happen. periodt.

👑 OPTIONS 👑

  • --rsearch <str> — search radius, in arcsec, for each iteration of the offset computation. (str; default: 30.,4.,2.,0.8). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.rsearch [default = 30.,4.,2.,0.8].
  • --nbins <int> — how many bins to use for the 2D histogram on the first iteration of the offset computation. (int; default: 60). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.nbins [default = 60].
  • --weight <bool> — use weighting. (bool; default: True). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.weight [default = True].
  • --fwhm <float> — FWHM in pixels of the convolution filter. (float; default: 5.0). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.fwhm [default = 5.0].
  • --threshold <float> — initial intensity threshold for detecting point sources. if the value is negative or zero, the threshold is taken as sigma above median background MAD. if it's larger than zero, the threshold is taken as the absolute background level. (float; default: 15.0). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.threshold [default = 15.0].
  • --bkgignore <float> — fraction of the image to be ignored. (float; default: 0.05). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.bkgignore [default = 0.05].
  • --bkgfraction <float> — fraction of the image (without the ignored part) to be considered as background. (float; default: 0.1). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.bkgfraction [default = 0.1].
  • --step <float> — increment/decrement of the threshold value in subsequent iterations. (float; default: 0.5). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.step [default = 0.5].
  • --iterations <int> — maximum number of iterations used for detecting sources. (int; default: 100000). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.iterations [default = 100000].
  • --srcmin <int> — minimum number of sources which must be found. (int; default: 5). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.srcmin [default = 5].
  • --srcmax <int> — maximum number of sources which may be found. (int; default: 80). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.srcmax [default = 80].
  • --roundmin <float> — lower limit of the allowed point-source roundness. (float; default: -1.0). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.roundmin [default = -1.0].
  • --roundmax <float> — upper limit of the allowed point-source roundness. (float; default: 1.0). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.roundmax [default = 1.0].
  • --sharpmin <float> — lower limit of the allowed point-source sharpness. (float; default: 0.2). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.sharpmin [default = 0.2].
  • --sharpmax <float> — upper limit of the allowed point-source sharpness. (float; default: 1.0). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.sharpmax [default = 1.0].
  • --expmap <bool> — enables the creation of a simple exposure map for the combined field-of-view. (bool; default: False). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.expmap [default = False].
  • --bpixdistance <float> — minimum allowed distance of a source to the closest bad pixel, in pixels. detected sources that are closer to a bad pixel are not taken into account when computing the field offsets. heads up: this option has no effect if the source positions are taken from input catalogs. (float; default: 5.0). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.bpixdistance [default = 5.0].
  • --override_detection <bool> — overrides the source detection step. if this is enabled and source catalogs are present in the input data set, the source positions used to calculate the field offsets are read from the input catalogs. if no catalogs are available as input data, the source positions are detected on the input images. (bool; default: False). the full name of this option for the EsoRex configuration file is muse.muse_exp_align.override_detection [default = False].
💡 side note bestie: you can make a configuration file holding these options, along with suitable default values. for the deets, go look at what 'esorex --help' tells you ✨

🔥 SEE ALSO 🔥

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

ftp://ftp.eso.org/pub/dfs/pipelines/muse/muse-pipeline-cookbook-2.8.7.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 is hanging out at the esorex (1) man page.

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 muse pipeline, in all their glory: muse_ampl(7), muse_astrometry(7), muse_bias(7), muse_create_sky(7), muse_dark(7), muse_exp_combine(7), muse_flat(7), muse_geometry(7), muse_illum(7), muse_lingain(7), muse_lsf(7), muse_qi_mask(7), muse_scibasic(7), muse_scipost(7), muse_scipost_apply_astrometry(7), muse_scipost_calibrate_flux(7), muse_scipost_combine_pixtables(7), muse_scipost_correct_dar(7), muse_scipost_correct_rv(7), muse_scipost_make_cube(7), muse_scipost_raman(7), muse_scipost_subtract_sky(7), muse_scipost_subtract_sky_simple(7), muse_standard(7), muse_twilight(7), muse_wavecal(7)

⭐ VERSION ⭐

muse_exp_align 2.8.7

💜 AUTHOR 💜

Ralf Palsa <https://support.eso.org>

🎀 BUG REPORTS 🎀

pls 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 nice, promise 🙈)

🌈 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

and that's the whole page bestie!! 💖✨ this was muse_exp_align 2.8.7, living in section 7 of the muse recipes manual — source and version as above, mwah 💅🦋 go align something iconic, you've got this 👑🌸

📦 where this page comes from