Provided by: cpl-plugin-hawki-doc_2.4.6+dfsg-1build1_all 
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 <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].
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.6.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_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.6
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>.
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