HAWKI_CAL_ZPOINT(7)

πŸ“¦
version 2.4.11 Β· 2 versions
, in debian bookworm, ubuntu noble

πŸ’– HAWKI_CAL_ZPOINT(7) β€” hawki recipes πŸ’–

okay bestie, welcome to HAWKI_CAL_ZPOINT(7), one of the hawki recipe manual pages, and before we go ANY further you need to know that this whole thing is tagged (OBSOLETE). Like, the recipe itself is literally labeled obsolete in its own NAME line. It's giving vintage. It's giving "still documented, still here, still valid syntax." We respect it. πŸ’…


✨ NAME ✨

hawki_cal_zpoint β€” (OBSOLETE) Zero point computation recipe πŸŽ€


🌸 SYNOPSIS 🌸

esorex hawki_cal_zpoint [OPTIONS] FILE.sof

that's it, that's the whole vibe: you run it through esorex, you feed it a .sof file, you optionally pass some options. slay. ✨


πŸ¦‹ DESCRIPTION πŸ¦‹

(OBSOLETE) β€” yes, again, we're saying it out loud. hawki_cal_zpoint is the Zero point recipe. πŸ‘‘

The input files you list in the Set Of Frames (that's the sof-file, iykyk) have to be tagged like this:

  • raw-file.fits ZPOINT
  • stdstars-file.fits STDSTARS_CATS
  • flat-file.fits FLAT_IM
  • bpm-file.fits BPM

and in exchange, the recipe makes you these outputs, no cap:

  • hawki_cal_zpoint.fits (ZPOINT_RES) β€” the Zero point solution table πŸ“Š
  • hawki_cal_zpoint_check.fits (ZPOINT_IMA) β€” standard star images, corrected, for checking purposes πŸ‘€
  • hawki_cal_zpoint_stats.fits (ZPOINT_STATS) β€” statistics of the raw standard star images πŸ“ˆ

Return code: esorex exits with an error code of 0 if the recipe completes successfully, or 1 otherwise. that's the whole mood chart β€” 0 is the win, 1 is the "bestie we need to talk." 😭


πŸ’… OPTIONS πŸ’…

okay here's the full list, every single one, defaults and all, because we do NOT gatekeep:

  • --detect_sigma <float> β€” the sigma value for object detection (float; default: 7.0). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.detect_sigma [default = 7.0].
  • --star_r <float> β€” the star radius (float; default: -1.0). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.star_r [default = -1.0].
  • --bg_r1 <float> β€” the internal background radius (float; default: -1.0). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.bg_r1 [default = -1.0].
  • --bg_r2 <float> β€” the external background radius (float; default: -1.0). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.bg_r2 [default = -1.0].
  • --ra <float> β€” RA in degrees (float; default: 999.0). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.ra [default = 999.0].
  • --dec <float> β€” DEC in degrees (float; default: 999.0). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.dec [default = 999.0].
  • --mag <float> β€” magnitude (float; default: 99.0). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.mag [default = 99.0].
  • --sx <int> β€” x half-size of the search box (int; default: 100). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.sx [default = 100].
  • --sy <int> β€” y half-size of the search box (int; default: 100). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.sy [default = 100].
  • --xcoord <str> β€” Coordinates in X where the standard star is located. If -1 use WCS (str; default: Β΄-1., -1., -1., -1.Β΄). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.xcoord [default = -1., -1., -1., -1.].
  • --ycoord <str> β€” Coordinates in Y where the standard star is located. If -1 use WCS (str; default: Β΄-1., -1., -1., -1.Β΄). The full name of this option for the EsoRex configuration file is hawki.hawki_cal_zpoint.ycoord [default = -1., -1., -1., -1.].
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. πŸ’‘

🌈 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 now, the whole recipe fam 🫢 β€” the other recipes of the hawki pipeline are hawki_cal_dark(7), hawki_cal_distortion(7), hawki_cal_flat(7), hawki_dark_combine(7), hawki_detector_noise(7), hawki_linearity_analyse(7), hawki_sci_jitter(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_cal_zpoint 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>. like, actually tell them, they want to know, 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


and that's the whole page bestie πŸ’œ this was hawki_cal_zpoint version 2.4.11, and yeah, the recipe is obsolete, but the documentation? iconic, eternal, still accurate. no cap. 🌟

πŸ“¦ where this page comes from