HAWKI_SCIENCE_PROCESS(7)

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

✨ HAWKI_SCIENCE_PROCESS(7) ✨

okay bestie, welcome to hawki_science_process, the HAWKI jitter recipe 💖 this is manual page HAWKI_SCIENCE_PROCESS(7) and we're gonna get you so comfy with it. no cap.

🌸 NAME 🌸

hawki_science_process — HAWKI jitter recipe. that's the whole vibe. slay ✨

🎀 SYNOPSIS 🎀

esorex hawki_science_process [OPTIONS] FILE.sof

like literally just call it and hand it a .sof file, she'll handle the rest 💅

🦋 DESCRIPTION 🦋

okay so hawki_science_process is the HAWKI science product recipe. she processes a complete pawprint of HAWKI data — icon behavior fr fr. here's the to-do list she's running through:

  • remove the instrumental signature
  • remove the sky background
  • combine the jitters
  • photometrically and astrometrically calibrate the pawprint image

main character energy honestly 😭✨

🧚 what she wants in the SOF

the program accepts the following files in the SOF, and bestie, pay attention, because this is the whole guest list:

  • OBJECT — A list of raw science images
  • SKY — A list of offset sky exposures (optional)
  • MASTER_DARK — A master dark frame
  • MASTER_TWILIGHT_FLAT — A master twilight flat frame
  • MASTER_SKY — A master sky frame (optional)
  • MASTER_SKY_VAR — A master sky variance frame (optional)
  • PHOTCAL_TAB — A photometric calibration table
  • MASTER_CONF — A master confidence map
  • MASTER_READGAIN — A master readgain table
  • MASTER_2MASS_CATALOGUE_ASTROM — A master 2MASS index for astrometry or
  • MASTER_PPMXL_CATALOGUE_ASTROM — A master PPMXL index for astrometry or
  • MASTER_LOCAL_CATALOGUE_ASTROM — A master local astrometric FITS file
  • MASTER_2MASS_CATALOGUE_PHOTOM — A master 2MASS index for photometry or
  • MASTER_PPMXL_CATALOGUE_PHOTOM — A master PPMXL index for photometry or
  • MASTER_LOCAL_CATALOGUE_PHOTOM — A master local photometric FITS file
  • MATCHSTD_PHOTOM — A master matched standards catalogue for photometry
  • MASTER_OBJMASK — A master object mask (optional)
  • SCHLEGEL_MAP_NORTH — Northern Schlegel Map
  • SCHLEGEL_MAP_SOUTH — Southern Schlegel Map
⚠️ heads up: all of the above are required unless specifically tagged as optional. the astrometric and photometric files are not required if these can be obtained from the CDS using the --cdssearch options 👑

💅 OPTIONS 💅

one bullet per option, no skipping, we're doing all of them because that's what icons do ✨

  • --savecat <bool> — Save catalogue? (bool; default: False). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.savecat [default = False].
  • --savemstd <bool> — Save matched standard catalogues? (bool; default: False). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.savemstd [default = False].
  • --skyalgo <str> — Sky subtraction algorithm (str; default: auto). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.skyalgo [default = auto].
  • --preview_only <bool> — Preview only? (bool; default: False). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.preview_only [default = False].
  • --minphotom <int> — Minimum stars for photometry solution (int; default: 1). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.minphotom [default = 1].
  • --prettynames <bool> — Use pretty product names? (bool; default: False). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.prettynames [default = False].
  • --cdssearch_astrom <str> — CDS astrometric catalogue (str; default: none). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.cdssearch_astrom [default = none].
  • --cdssearch_photom <str> — CDS photometric catalogue (str; default: none). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.cdssearch_photom [default = none].
  • --stk_cat_ipix <int> — Minimum pixel area for each detected object (int; default: 10). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_cat_ipix [default = 10].
  • --stk_cat_thresh <float> — Detection threshold in sigma above sky (float; default: 2.5). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_cat_thresh [default = 2.5].
  • --stk_cat_icrowd <bool> — Use deblending? (bool; default: True). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_cat_icrowd [default = True].
  • --stk_cat_rcore <float> — Value of Rcore in pixels (float; default: 10.0). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_cat_rcore [default = 10.0].
  • --stk_cat_nbsize <int> — Background smoothing box size (int; default: 128). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_cat_nbsize [default = 128].
  • --stk_lthr <float> — Low rejection threshold (float; default: 5.0). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_lthr [default = 5.0].
  • --stk_hthr <float> — Upper rejection threshold (float; default: 5.0). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_hthr [default = 5.0].
  • --stk_method <str> — Stacking method (str; default: linear). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_method [default = linear].
  • --stk_seeing <bool> — Weight by seeing? (bool; default: False). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_seeing [default = False].
  • --stk_fast <str> — Use fast stacking? (str; default: auto). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_fast [default = auto].
  • --stk_nfst <int> — Nframes for slow stacking (int; default: 30). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.stk_nfst [default = 30].
  • --psm_ipix <int> — Minimum pixel area for each detected object (int; default: 10). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.psm_ipix [default = 10].
  • --psm_niter <int> — Number of iterations in pawsky mask (int; default: 5). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.psm_niter [default = 5].
  • --psm_thresh <float> — Detection threshold in sigma above sky (float; default: 1.5). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.psm_thresh [default = 1.5].
  • --psm_nbsize <int> — Background smoothing box size (int; default: 128). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.psm_nbsize [default = 128].
  • --psm_smkern <float> — Smoothing kernel size (pixels) (float; default: 2.0). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.psm_smkern [default = 2.0].
  • --cacheloc <str> — Location for standard star cache (str; default: .). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.cacheloc [default = .].
  • --magerrcut <float> — Magnitude error cut (float; default: 100.0). The full name of this option for the EsoRex configuration file is hawki.hawki_science_process.magerrcut [default = 100.0].
💡 psst — note that 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. iykyk 💜

🌈 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 ✨

and the other recipes of the hawki pipeline, aka the whole friend group, are: 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_sci_jitter(7), hawki_science_postprocess(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_science_process 2.4.11

👑 AUTHOR 👑

Jim Lewis <jrl@ast.cam.ac.uk> — the icon, the moment, the legend 🎀

🙈 BUG REPORTS 🙈

please report any problems to jrl@ast.cam.ac.uk. alternatively, you may send a report to the ESO User Support Department <usd-help@eso.org>. they want to hear from you bestie, don't be shy 💌

📜 LICENSE 📜

this file is part of the HAWKI Instrument Pipeline Copyright (C) 2015 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. (not me copy-pasting legal text but it's literally the rules 😭)

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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

and that's the whole page bestie!! this was hawki_science_process 2.4.11 from the HAWKI_SCIENCE_PROCESS(7) manual, hawki recipes edition — go process a pawprint and slay 💖✨🌸🦋🎀

📦 where this page comes from