HAWKI_SCIENCE_POSTPROCESS(7)

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

💅 hawki_science_postprocess(7) 💅

okay bestie, this is the manual page for hawki_science_postprocess, one of the hawki recipes. sit down, grab a strawberry 🍓, and let's get into it.

✨ NAME ✨

hawki_science_postprocess — the HAWKI post processing recipe. yes that's the whole name. iconic, lowkey.

🦋 SYNOPSIS 🦋

esorex hawki_science_postprocess [OPTIONS] FILE.sof

that's it. that's the whole vibe check.

🌸 DESCRIPTION 🌸

so hawki_science_postprocess is literally the HAWKI science post processing recipe, no cap.

what it does: it postprocesses a stacked pawprint for HAWKI data. it forms a filled tile, then photometrically and astrometrically calibrates that tiled image. optionally — if you're feeling spicy — it can nebulise the stacked images before source detection. main character energy fr fr.

🎀 what files it wants in the SOF

the program accepts the following files in the SOF:

  • BASIC_CALIBRATED_SCI — a set of processed images from a jitter sequence
  • BASIC_VAR_MAP — a variance map for each sequence image
  • MASTER_CONF — a master confidence map for the jitter sequence
  • PHOTCAL_TAB — a photometric calibration 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 photometry, or
  • MASTER_LOCAL_CATALOGUE_PHOTOM — a master local photometric FITS file
  • MATCHSTD_PHOTOM — a master photometric matched stds catalogue (optional)
  • SCHLEGEL_MAP_NORTH — Northern Schlegel Map
  • SCHLEGEL_MAP_SOUTH — Southern Schlegel Map
🫶 heads up bestie: all of the above are required unless specified otherwise. the astrometric and photometric files are not required if these can be obtained from the CDS using the --cdssearch options. so like, you have options. slay.

👑 OPTIONS 👑

sixteen of them. every single one. let's go 💅

  • --nebulise <bool> — nebulise the stacks before object detection? (bool; default: False). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.nebulise [default = False].
  • --minphotom <int> — minimum number of stars for photometry solution (int; default: 20). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.minphotom [default = 20].
  • --prettynames <bool> — use pretty product names? (bool; default: False). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.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_postprocess.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_postprocess.cdssearch_photom [default = none].
  • --stk_fast <str> — use fast stacking? (str; default: auto). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.stk_fast [default = auto].
  • --stk_nfst <int> — Nframes before we switch to slow stack algorithm (int; default: 30). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.stk_nfst [default = 30].
  • --savemstd <bool> — save matched standard catalogues? (bool; default: False). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.savemstd [default = False].
  • --neb_medfilt <int> — median filter size for nebuliser (int; default: 101). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.neb_medfilt [default = 101].
  • --neb_linfilt <int> — linear filter size for nebuliser (int; default: 33). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.neb_linfilt [default = 33].
  • --cat_ipix <int> — minimum pixel area for each detected object (int; default: 4). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.cat_ipix [default = 4].
  • --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_postprocess.cat_thresh [default = 2.5].
  • --cat_icrowd <bool> — use deblending? (bool; default: True). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.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_science_postprocess.cat_rcore [default = 10.0].
  • --cat_nbsize <int> — background smoothing box size (int; default: 64). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.cat_nbsize [default = 64].
  • --cacheloc <str> — location for standard star cache (str; default: .). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.cacheloc [default = .].
  • --magerrcut <float> — cut in magnitude error (float; default: 100.0). the full name of this option for the EsoRex configuration file is hawki.hawki_science_postprocess.magerrcut [default = 100.0].
💡 oh also — 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. you're welcome 🫶

🌈 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_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_science_postprocess 2.4.11

🧚 AUTHOR 🧚

Jim Lewis <jrl@ast.cam.ac.uk>

💀 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 nice, they got you 🫶

📜 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.

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_postprocess 2.4.11, from the hawki recipes, and yes — she ate. periodt. ✨🦋💅🌸👑

📦 where this page comes from