NACO_IMG_JITTER(7)

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

💖 NAME 💖

naco_img_jitter — the Jitter recipe, bestie. she jitters, she stacks, she serves.

✨ SYNOPSIS ✨

esorex naco_img_jitter [OPTIONS] FILE.sof

🦋 DESCRIPTION 🦋

okay so naco_img_jitter is the NACO imaging jitter recipe. that's the whole vibe. 💅

but listen — the files you put in your Set Of Frames (the sof-file, iykyk) have to be tagged correctly, or it's giving chaos. here's the tag roster, no cap:

  • NACO-raw-file.fits IM_JITTER_OBJ
  • NACO-raw-file.fits IM_JITTER_SKY
  • NACO-raw-file.fits POL_JITTER_OBJ
  • NACO-raw-file.fits POL_JITTER_SKY
  • NACO-flat-file.fits MASTER_IMG_FLAT
  • NACO-bpm-file.fits MASTER_IMG_FLAT_BADPIX
  • NACO-dark-file.fits NACO_IMG_DARK_AVG

tag them right or the recipe simply will not know what you're on about. 🫶

🌸 OPTIONS 🌸

  • --off <str> — an optional ASCII spec of the offsets, for when the ones hiding in the FITS-headers are missing or just plain wrong 🙈. the file has to have one line per object FITS-file, and each line is two numbers = the shift in pixels of that image relative to the first image. so the first line should literally just be two zeros, because the first image is not shifted from itself, bestie. correct FITS-header offsets mean you can get the i´th X offset from Xoffset_0 - Xoffset_i, where Xoffset_i is the value of ESO SEQ CUMOFFSETX, and same energy for Y. (str; default: None). the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.offsets [default = None].
  • --objs <str> — objects file (str; default: None). the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.objects [default = None].
  • --oddeven <bool> — apply the odd-even correction. ⚠️ Warning: this flag currently has no effect — she's decorative, she's a vibe, she does nothing (bool; default: False). the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.oddeven [default = False].
  • --xcorr <str> — cross correlation search and measure sizes (str; default: ´40 40 65 65´). the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.xcorr [default = 40 40 65 65].
  • --union <bool> — combine images using their union, as opposed to their intersection (deprecated and ignored, see --combine_method) (bool; default: True). yeah she's deprecated, don't get attached 💀. the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.union [default = True].
  • --rej <str> — low and high number of rejected values (str; default: ´2 2´). the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.rej [default = 2 2].
  • --combine_method <str> — combine images using one of: 1) Onto the first image (first); 2) Their union (union); 3) Their intersection (inter). NB: only the ´first´-method produces an image product with WCS coordinates — the others are WCS-less girlies. a successful ´first´-method always produces a combined image with dimensions equal to those of the input images. for the ´union´-method the result image is at least as large as the input images, while for the ´inter´-method the result image is at most as large as the input images (str; default: ´union´). the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.comb_meth [default = union].
  • --sky_planes <int> — estimate the sky using the median of the last n planes in the previous cube and the first n planes in the following cube. if the cube has fewer than n planes, then use all planes. zero means all. (Ignored for non-cube data) (int; default: 25). the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.sky_planes [default = 25].
  • --cube_mode <str> — collapse cube data using one of: 1) No recentering (add); 2) Shift-and-Add (saa). (Ignored for non-cube data) (str; default: ´saa´). the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.cube_mode [default = saa].
  • --lucky <float> — in cube mode, use only the frames with a strehl ratio in the given top fraction. (Ignored for non-cube data) (float; default: 1.0). the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.lucky_strehl [default = 1.0].
  • --save_cube <bool> — append the cube of corrected object images that are shifted added together to the product (bool; default: False). the full name of this option for the EsoRex configuration file is naco.naco_img_jitter.save_cube [default = False].
btw 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. 👑

🔥 SEE ALSO 🔥

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

ftp://ftp.eso.org/pub/dfs/pipelines/naco/naco-pipeline-manual-1.1.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.

the other recipes of the naco pipeline are naco_img_checkfocus(7), naco_img_dark(7), naco_img_detlin(7), naco_img_lampflat(7), naco_img_slitpos(7), naco_img_strehl(7), naco_img_twflat(7), naco_img_zpoint(7), naco_spc_combine(7), naco_spc_lampflat(7), naco_spc_wavecal(7), naco_util_img_std_cat(7), naco_util_spc_argon(7), naco_util_spc_model(7) — the whole friend group, periodt. 💖

⭐ VERSION ⭐

naco_img_jitter 4.4.11

🎀 AUTHOR 🎀

Lars Lundin <usd-help@eso.org>

💀 BUG REPORTS 💀

please report any problems to usd-help@eso.org. alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>. they're the same address but hey, options are options. 🙈

👑 LICENSE 👑

this file is part of the NACO Instrument Pipeline Copyright (C) 2002, 2003, 2005, 2008 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 thing bestie, slay 💅✨ this came straight out of the naco recipes corner of the manual, version 4.4.11 — go forth and jitter responsibly, love u, bye 🦋🌸

📦 where this page comes from