--- name: "hawki_sci_jitter" 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_sci_jitter" --- # hawki\_sci\_jitter(7) (OBSOLETE) Jitter recipe ## NAME hawki\_sci\_jitter - (OBSOLETE) Jitter recipe ## SYNOPSIS esorex **hawki\_sci\_jitter** \[OPTIONS\] FILE.sof ## DESCRIPTION (OBSOLETE) 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 ## OPTIONS - **--offsets** *\* 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** *\* 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** *\* Maximum offset allowed (int; default: 1500). The full name of this option for the EsoRex configuration file is **hawki.hawki\_sci\_jitter.offset\_max** \[default = *1500*\]. - **--sky\_par** *\* 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** *\* 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** *\* 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** *\* 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** *\* 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** *\* Borders rejected (int; default: 4). The full name of this option for the EsoRex configuration file is **hawki.hawki\_sci\_jitter.borders** \[default = *4*\]. - **--max\_njitter** *\* Maximum numbers of jitter frames to combine (int; 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. ## 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\_science\_postprocess*(7)](/hawki_science_postprocess/7.md), [*hawki\_science\_process*(7)](/hawki_science_process/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\_sci\_jitter 2.4.11 ## AUTHOR ESO Pipeline Group \ ## BUG REPORTS Please report any problems to https://support.eso.org. Alternatively, you may send a report to the ESO User Support Department \. ## LICENSE 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