--- name: "hawki_cal_flat" 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_cal_flat" --- # hawki\_cal\_flat(7) (OBSOLETE) Twillight flat recipe ## NAME hawki\_cal\_flat - (OBSOLETE) Twillight flat recipe ## SYNOPSIS esorex **hawki\_cal\_flat** \[OPTIONS\] FILE.sof ## DESCRIPTION (OBSOLETE) hawki\_cal\_flat -- HAWK��I imaging flat-field creation from twillight images. The input of the recipe files listed in the Set Of Frames (sof-file) must be tagged as: raw-file.fits FLAT or Optional inputs are: bpmdark-file.fits BPM\_HOT dark-file.fits DARK\_IM dark\_err-file.fits DARK\_ERR The recipe creates as an output: hawki\_cal\_flat\_setxx.fits (FLAT\_IM): Master flat for filter xx hawki\_cal\_flat\_err\_setxx.fits (FLAT\_ERRMAP): Master flat residuals hawki\_cal\_flat\_bpmflat\_setxx.fits (BPM\_COLD): BPM from the flat hawki\_cal\_flat\_stats\_setxx.fits (FLAT\_STATS): Stats of the individual flats Optionally it also creates: hawki\_cal\_flat\_bpm\_setxx.fits (BPM): Bad pixel mask combining bpm from dark and flat hawki\_cal\_flat\_stats\_ec\_setxx.fits (FLAT\_STATS\_EVEN\_COL): Stats of the individual flats for even columns hawki\_cal\_flat\_stats\_oc\_setxx.fits (FLAT\_STATS\_ODD\_COL): Stats of the individual flats for odd columns hawki\_cal\_flat\_stats\_er\_setxx.fits (FLAT\_STATS\_EVEN\_ROW): Stats of the individual flats for even rows hawki\_cal\_flat\_stats\_or\_setxx.fits (FLAT\_STATS\_ODD\_ROW): Stats of the individual flats for odd rows Return code: esorex exits with an error code of 0 if the recipe completes successfully or 1 otherwise ## OPTIONS - **--zone** *\* Stats zone (str; default: ´1,1,2048,2048´). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.zone** \[default = *1,1,2048,2048*\]. - **--normalise** *\* Flag to apply the normalisation (bool; default: False). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.normalise** \[default = *False*\]. - **--second\_pass** *\* Flag to apply a second pass computation (bool; default: True). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.second\_pass** \[default = *True*\]. - **--sigma\_badres** *\* sigma for detection of bad flat results (float; default: 1.0). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.sigma\_badres** \[default = *1.0*\]. - **--sigma\_bpm** *\* sigma for detection of bad pixels (float; default: 10.0). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.sigma\_bpm** \[default = *10.0*\]. - **--lowval\_bpm** *\* values of the flat below this will be included in the bpm. In units of final flat (normalised if normalise is on) (float; default: 0.1). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.lowval\_bpm** \[default = *0.1*\]. - **--highval\_bpm** *\* values of the flat above this will be included in the bpm. In units of final flat (normalized if normalise is on) (float; default: 10.0). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.highval\_bpm** \[default = *10.0*\]. - **--select\_auto** *\* Flag to automatically select the good input frames (bool; default: True). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.select\_auto** \[default = *True*\]. - **--select\_auto\_max\_bins** *\* Maximum number of frames requested (int; default: 10). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.select\_auto\_max\_bins** \[default = *10*\]. - **--select\_min\_level** *\* Minimum ADU level for frames selection (str; default: ´-1.0´). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.select\_min\_level** \[default = *-1.0*\]. - **--select\_max\_level** *\* Maximum ADU level for frames selection (str; default: ´25000´). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.select\_max\_level** \[default = *25000*\]. - **--select\_max\_rms** *\* Maximum RMS for frames selection (str; default: ´4000´). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.select\_max\_rms** \[default = *4000*\]. - **--select\_min\_nframes** *\* Minimum number of frames requested (int; default: 3). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.select\_min\_nframes** \[default = *3*\]. - **--extra\_stats** *\* Request for even/odd column/rows statistics (bool; default: False). The full name of this option for the EsoRex configuration file is **hawki.hawki\_cal\_flat.extra\_stats** \[default = *False*\]. 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\_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\_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\_cal\_flat 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