--- name: "hawki_science_process" section: "7" platform: "linux" package: "cpl-plugin-hawki-doc" version: "2.4.11+dfsg-1" release: "Debian 12 (Bookworm)" platforms: ["linux"] url: "https://new.carta.tech/hawki_science_process" --- # hawki\_science\_process(7) HAWKI jitter recipe ## NAME hawki\_science\_process - HAWKI jitter recipe ## SYNOPSIS esorex **hawki\_science\_process** \[OPTIONS\] FILE.sof ## DESCRIPTION hawki\_science\_process -- HAWKI science product recipe. Process a complete pawprint of HAWKI data. Remove instrumental signature, remove sky background, combine jitters, photometrically and astrometrically calibrate the pawprint image The program accepts the following files in the SOF: Tag Description 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 All of the above are required unless specifically tagged as optional. Theastrometric and photometric files are not required if these can be obtainedfrom the CDS using the --cdssearch options ## OPTIONS - **--savecat** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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*\]. 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. The other recipes of the hawki pipeline are [*hawki\_cal\_dark*(7)](/hawki_cal_dark/7.md), [*hawki\_cal\_distortion*(7)](/hawki_cal_distortion/7.md), [*hawki\_cal\_flat*(7)](/hawki_cal_flat/7.md), [*hawki\_cal\_zpoint*(7)](/hawki_cal_zpoint/7.md), [*hawki\_dark\_combine*(7)](/hawki_dark_combine/7.md), [*hawki\_detector\_noise*(7)](/hawki_detector_noise/7.md), [*hawki\_linearity\_analyse*(7)](/hawki_linearity_analyse/7.md), [*hawki\_sci\_jitter*(7)](/hawki_sci_jitter/7.md), [*hawki\_science\_postprocess*(7)](/hawki_science_postprocess/7.md), [*hawki\_standard\_process*(7)](/hawki_standard_process/7.md), [*hawki\_step\_apply\_dist*(7)](/hawki_step_apply_dist/7.md), [*hawki\_step\_basic\_calib*(7)](/hawki_step_basic_calib/7.md), [*hawki\_step\_combine*(7)](/hawki_step_combine/7.md), [*hawki\_step\_compute\_bkg*(7)](/hawki_step_compute_bkg/7.md), [*hawki\_step\_detect\_obj*(7)](/hawki_step_detect_obj/7.md), [*hawki\_step\_photom\_2mass*(7)](/hawki_step_photom_2mass/7.md), [*hawki\_step\_refine\_offsets*(7)](/hawki_step_refine_offsets/7.md), [*hawki\_step\_stats*(7)](/hawki_step_stats/7.md), [*hawki\_step\_stitch*(7)](/hawki_step_stitch/7.md), [*hawki\_step\_subtract\_bkg*(7)](/hawki_step_subtract_bkg/7.md), [*hawki\_tec\_filtchk*(7)](/hawki_tec_filtchk/7.md), [*hawki\_twilight\_flat\_combine*(7)](/hawki_twilight_flat_combine/7.md), [*hawki\_util\_gendist*(7)](/hawki_util_gendist/7.md), [*hawki\_util\_stdstars*(7)](/hawki_util_stdstars/7.md) ## VERSION hawki\_science\_process 2.4.11 ## AUTHOR Jim Lewis \ ## BUG REPORTS Please report any problems to jrl@ast.cam.ac.uk. Alternatively, you may send a report to the ESO User Support Department \. ## 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