HAWKI_STANDARD_PROCESS(7)

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

HAWKI_STANDARD_PROCESS ✨ (that's the HAWKI_STANDARD_PROCESS(7) page, bestie — hawki recipes, section 7, we love a manual section) 🎀

🌸 NAME 🌸

hawki_standard_process — the HAWKI standard field recipe 💖

🦋 SYNOPSIS 🦋

esorex hawki_standard_process [OPTIONS] FILE.sof

✨ DESCRIPTION ✨

Okay so hawki_standard_process is the HAWKI standard field recipe, periodt.

It processes a pawprint for HAWKI standard data. It removes the instrumental signature, removes the sky background, and then photometrically and astrometrically calibrates each image in the pawprint individually 💅 (yes, individually, one at a time, main character energy for every frame).

The program accepts the following files in the SOF:

  • STD — a list of raw standard field images 🍓
  • MASTER_DARK — a master dark frame 🌑
  • MASTER_TWILIGHT_FLAT — a master twilight flat frame 🌇
  • 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
  • SCHLEGEL_MAP_NORTH — Northern Schlegel Map 🧭
  • SCHLEGEL_MAP_SOUTH — Southern Schlegel Map 🧭

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 💅

  • --preview_only <bool> — Preview only? (bool; default: False). The full name of this option for the EsoRex configuration file is hawki.hawki_standard_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_standard_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_standard_process.prettynames [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_standard_process.savemstd [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_standard_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_standard_process.cdssearch_photom [default = none]. 🔭
  • --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_standard_process.src_cat_ipix [default = 10]. 🔍
  • --cat_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_standard_process.src_cat_thresh [default = 1.5]. 📈
  • --cat_icrowd <bool> — Use deblending? (bool; default: True). The full name of this option for the EsoRex configuration file is hawki.hawki_standard_process.src_cat_icrowd [default = True]. 🫂
  • --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_standard_process.src_cat_rcore [default = 10.0]. ⭕
  • --cat_nbsize <int> — Background smoothing box size (int; default: 128). The full name of this option for the EsoRex configuration file is hawki.hawki_standard_process.src_cat_nbsize [default = 128]. 🧊
  • --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_standard_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_standard_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_standard_process.psm_thresh [default = 1.5]. 📈
  • --psm_nbsize <int> — Background smoothing box size (int; default: 256). The full name of this option for the EsoRex configuration file is hawki.hawki_standard_process.psm_nbsize [default = 256]. 🧊
  • --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_standard_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_standard_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_standard_process.magerrcut [default = 100.0]. ✂️
Not me telling you that you can literally create a configuration file containing these options, along with suitable default values 😭 Please refer to the details provided by the 'esorex --help' command, bestie, it's giving helpful.

👑 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 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_science_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_standard_process 2.4.11 🎀

🫶 AUTHOR 🫶

Jim Lewis <jrl@ast.cam.ac.uk> — icon, legend, ate 💜

😭 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're literally there to help, no cap 🫶

📜 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. 💀 (yes this is the all-caps legal part, it's serious, respect it)

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 💌

Anyways bestie, that's the whole thing — hawki_standard_process, version 2.4.11, from the hawki recipes collection, page HAWKI_STANDARD_PROCESS(7). Slay, go calibrate some standards, and remember: astrometry and photometry are a package deal, iykyk 🦋✨💅

📦 where this page comes from