HAWKI_SCI_JITTER(7)

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

💖 HAWKI_SCI_JITTER(7) — hawki recipes 💖

okay bestie, welcome to the hawki recipe corner of the man pages, this one's filed under hawki recipes and it's the one and only hawki_sci_jitter. it's giving vintage, it's giving legacy, and yes we'll get to the part where it says OBSOLETE. deep breaths. 🫶

✨ NAME ✨

hawki_sci_jitter — (OBSOLETE) Jitter recipe. that's it, that's the name, no notes 💅

🌈 SYNOPSIS 🌈

esorex hawki_sci_jitter [OPTIONS] FILE.sof

🦋 DESCRIPTION 🦋

(OBSOLETE) bestie I need you to clock this first: hawki_sci_jitter is the hawki imaging jitter recipe, and it is marked obsolete. iconic but retired. periodt. 💀

so here's the vibe check on the input. the recipe files listed in the Set Of Frames (the sof-file) must be tagged like this:

  • raw-file.fits JITTER_OBS or
  • raw-file.fits JITTER_SKY or
  • flat-file.fits FLAT_IM or
  • dark-file.fits DARK_IM
  • bpm-file.fits BPM
  • distortion_x-file.fits DISTORTION_X
  • distortion_y-file.fits DISTORTION_Y

like, those tags are non-negotiable, it literally says must be tagged as. 🚨

the recipe creates as an output:

  • hawki_sci_jitter.fits (COMBINED)
  • hawki_sci_jitter_stitched.fits (STITCHED)
  • hawki_sci_jitter_stars.fits (OBJ_PARAM): detected objects properties
  • hawki_sci_jitter_stats.fits (JITTER_STATS): stats of the individual images
  • hawki_sci_jitter_bkg_stats.fits (BKG_STATS): statistics on the bkg

🧚 the steps, in order, no skipping 🧚

the recipe performs the following steps:

  1. Frame statistics
  2. Basic reduction (using FLAT_IM and BPM)
  3. Background computation (the algorithm depends on parameter --sky_par)
  4. Offset refinement (uses parameters --off, --refine and --xcorr)
  5. Stacking of jitter frames (uses --comb_meth, --rej, --offset_max, --borders, --max_njitter)
  6. Stitching of the four detectors into one image
  7. Object detection in the stacked image

Return code: esorex exits with an error code of 0 if the recipe completes successfully or 1 otherwise. so like, zero means slay, one means 😭.

💅 OPTIONS 💅

every single one of these, bestie, we're not skipping a single flag, that's the rule:

  • --offsets <str> — offsets file (str; default: None). the full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.offsets [default = None].
  • --objects <str> — objects file (str; default: None). the full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.objects [default = None].
  • --offset_max <int> — maximum offset allowed (int; default: 1500). the full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.offset_max [default = 1500].
  • --sky_par <str> — rejection parameters for sky filtering (str; default: ´10,7,3,3´). the full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.sky_par [default = 10,7,3,3].
  • --refine <bool> — refine offsets (bool; default: False). the full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.refine [default = False].
  • --xcorr <str> — cross correlation search and measure sizes (str; default: ´20,20,25,25´). the full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.xcorr [default = 20,20,25,25].
  • --comb_meth <str> — union / inter / first (str; default: ´union´). the full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.comb_meth [default = union].
  • --rej <str> — low and high number of rejected values (str; default: ´1,1´). the full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.rej [default = 1,1].
  • --borders <int> — borders rejected (int; default: 4). the full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.borders [default = 4].
  • --max_njitter <int> — maximum numbers of jitter frames to combine (int; default: -1). the full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.max_njitter [default = -1].
little heads up 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. go read it, it's free 💖

🔥 SEE ALSO 🔥

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

ftp://ftp.eso.org/pub/dfs/pipelines/hawki/hawki-pipeline-manual-2.4.11.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 hawki pipeline are, and yes I'm listing every single one because they're all invited to the party 🎀:

hawki_cal_dark(7), hawki_cal_distortion(7), hawki_cal_flat(7), hawki_cal_zpoint(7), hawki_dark_combine(7), hawki_detector_noise(7), hawki_linearity_analyse(7), hawki_science_postprocess(7), hawki_science_process(7), hawki_standard_process(7), hawki_step_apply_dist(7), hawki_step_basic_calib(7), hawki_step_combine(7), hawki_step_compute_bkg(7), hawki_step_detect_obj(7), hawki_step_photom_2mass(7), hawki_step_refine_offsets(7), hawki_step_stats(7), hawki_step_stitch(7), hawki_step_subtract_bkg(7), hawki_tec_filtchk(7), hawki_twilight_flat_combine(7), hawki_util_gendist(7), hawki_util_stdstars(7)

⭐ VERSION ⭐

hawki_sci_jitter 2.4.11

👑 AUTHOR 👑

ESO Pipeline Group <https://support.eso.org>

🙈 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're nice, fr fr. 🫶

🌸 LICENSE 🌸

this file is part of the HAWKI Instrument Pipeline Copyright (C) 2002,2011 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 Street, Fifth Floor, Boston, MA 02110-1301 USA

okay that's the whole page bestie, go forth and jitter responsibly 💖✨

and a lil sign-off to close us out: this was hawki_sci_jitter, version 2.4.11, living inside the HAWKI_SCI_JITTER(7) page. mwah. 💅🎀🦋
📦 where this page comes from