Jitter recipe
esorex hawki_sci_jitter [OPTIONS] FILE.sof
hawki_sci_jitter -- hawki imaging jitter recipe.
The input of the recipe files listed in the Set Of Frames (sof-file) must be tagged as: raw-file.fits JITTER_OBS or raw-file.fits JITTER_SKY or flat-file.fits FLAT_IM or dark-file.fits DARK_IM bpm-file.fits BPM distortion_x-file.fits DISTORTION_X distortion_y-file.fits DISTORTION_Y
The recipe creates as an output: hawki_sci_jitter.fits (COMBINED) hawki_sci_jitter_stitched.fits (STITCHED) hawki_sci_jitter_stars.fits (OBJ_PARAM): Detected objects properties hawki_sci_jitter_stats.fits (JITTER_STATS): Stats of the individual images hawki_sci_jitter_bkg_stats.fits (BKG_STATS): Statistics on the bkg
The recipe performs the following steps: 1) Frame statistics 2) Basic reduction (using FLAT_IM and BPM) 3) Background computation (the algorithm depends on parameter --sky_par) 4) Offset refinement (uses parameters --off, --refine and --xcorr) 5) Stacking of jitter frames (uses --comb_meth, --rej,
--offset_max, --borders, --max_njitter)
6) Stitching of the four detectors into one image 7) Object detection in the stacked image
Return code: esorex exits with an error code of 0 if the recipe completes successfully or 1 otherwise
--offsets <str>
offsets file (str; default: None). The full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.offsets [default = None].
--objects <str>
objects file (str; default: None). The full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.objects [default = None].
--offset_max <long>
Maximum offset allowed (long; default: 1500). The full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.offset_max [default = 1500].
--sky_par <str>
Rejection parameters for sky filtering (str; default: \'10,7,3,3\'). The full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.sky_par [default = 10,7,3,3].
--refine <bool>
refine offsets (bool; default: False). The full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.refine [default = False].
--xcorr <str>
Cross correlation search and measure sizes (str; default: \'20,20,25,25\'). The full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.xcorr [default = 20,20,25,25].
--comb_meth <str>
union / inter / first (str; default: \'union\'). The full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.comb_meth [default = union].
--rej <str>
Low and high number of rejected values (str; default: \'1,1\'). The full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.rej [default = 1,1].
--borders <long>
Borders rejected (long; default: 4). The full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.borders [default = 4].
--max_njitter <long>
Maximum numbers of jitter frames to combine (long; default: -1). The full name of this option for the EsoRex configuration file is hawki.hawki_sci_jitter.max_njitter [default = -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.
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-1.8.14.pdf
An overview over the existing ESO pipelines can be found on the web page http://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 http://packages.python.org/python-cpl/index.html for further information.
The other recipes of the hawki pipeline are hawki_cal_zpoint(7), hawki_step_stats(7), hawki_step_apply_dist(7), hawki_cal_flat(7), hawki_step_detect_obj(7), hawki_util_stdstars(7), hawki_step_basic_calib(7), hawki_step_photom_2mass(7), hawki_cal_dark(7), hawki_step_compute_bkg(7), hawki_cal_distortion(7), hawki_util_gendist(7), hawki_tec_filtchk(7), hawki_step_subtract_bkg(7), hawki_step_refine_offsets(7), hawki_step_stitch(7), hawki_step_combine(7)
hawki_sci_jitter 1.8.14
Cesar Enrique Garcia <[email protected]>
Please report any problems to [email protected]. Alternatively, you may send a report to the ESO User Support Department <[email protected]>.
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