--- name: "hawki_step_compute_bkg" 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_step_compute_bkg" --- # hawki\_step\_compute\_bkg(7) (OBSOLETE) Background computing utility ## NAME hawki\_step\_compute\_bkg - (OBSOLETE) Background computing utility ## SYNOPSIS esorex **hawki\_step\_compute\_bkg** \[OPTIONS\] FILE.sof ## DESCRIPTION (OBSOLETE) hawki\_step\_compute\_bkg -- hawki background computation utility. This recipe will create the associated background images for a given set of object images. If there are sky images, these will be used to compute the background, otherwise, the background is computed using a running mean on the object images. An optional mask can be supplied for the running mean. The files listed in the Set Of Frames (sof-file) must be tagged: obj\_basic\_cal-file.fits BASIC\_CALIBRATED or sky\_basic\_cal-file.fits SKY\_BASIC\_CALIBRATED and optionally for object masking: object\_mask-file.fits OBJ\_MASK offsets.fits OFFSETS\_REFINED distortion\_x.fits DISTORTION\_X distortion\_y.fits DISTORTION\_Y ## OPTIONS - **--nmin\_comb** *\* Minimum number of jitter frames to use the running median (int; default: 10). The full name of this option for the EsoRex configuration file is **hawki.hawki\_step\_compute\_bkg.nmin\_comb** \[default = *10*\]. - **--nhalf\_window** *\* Number of images at both sides of the current ima to use for bkg in running median (int; default: 7). The full name of this option for the EsoRex configuration file is **hawki.hawki\_step\_compute\_bkg.nhalf\_window** \[default = *7*\]. - **--rejlow** *\* The number of frames with low level to reject (int; default: 2). The full name of this option for the EsoRex configuration file is **hawki.hawki\_step\_compute\_bkg.rejlow** \[default = *2*\]. - **--rejhigh** *\* The number of frames with high level to reject (int; default: 2). The full name of this option for the EsoRex configuration file is **hawki.hawki\_step\_compute\_bkg.rejhigh** \[default = *2*\]. 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\_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\_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\_step\_compute\_bkg 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