--- name: "vmimflatsky" section: "7" platform: "linux" package: "cpl-plugin-vimos-doc" version: "3.2.3+dfsg-2" release: "Debian 10 (Buster)" platforms: ["linux"] url: "https://new.carta.tech/vmimflatsky" --- # vmimflatsky(7) Create a master sky flat field from set of raw sky flat field frames. ## NAME vmimflatsky - Create a master sky flat field from set of raw sky flat field frames. ## SYNOPSIS esorex **vmimflatsky** \[OPTIONS\] FILE.sof ## DESCRIPTION This recipe is used to create a master sky flat field from a set of raw sky flat fields. The master sky flat field is the dataset used for the flat field correction of scientific data. Input files: DO category: Type: Explanation: Required:\ IMG\_SKY\_FLAT Raw Sky flat exposure Y\ MASTER\_BIAS Calib Master bias Y\ MASTER\_DARK Calib Master dark . IMG\_MASTER\_SCREEN\_FLAT Calib Master screen flat . CCD\_TABLE Calib Bad pixel table . Output files: DO category: Data type: Explanation:\ IMG\_MASTER\_SKY\_FLAT FITS image Master sky flat field If a master screen flat is specified, the input sky flat exposures are flat-fielded with it, and then just used to determine the large scale trends of the instrument response; the result is then multiplied by the master screen flat. A CCD table must be specified in input only if a bad pixel cleaning is requested. For more details, please refer to the VIMOS Pipeline User´s Guide. ## OPTIONS - **--SmoothBoxSize** *\* Size of running box used for smoothing (int; default: 7). The full name of this option for the EsoRex configuration file is **vimos.Parameters.smooth.boxsize** \[default = *7*\]. - **--SmoothMethod** *\* Smooth method for image trends removal (str; default: ´Median´). The full name of this option for the EsoRex configuration file is **vimos.Parameters.smooth.method** \[default = *Median*\]. - **--AllowSingleFrames** *\* Frame combination method is ignored. (bool; default: True). The full name of this option for the EsoRex configuration file is **vimos.Parameters.stacking.singleframes** \[default = *True*\]. - **--StackMethod** *\* Frames combination method (str; default: ´Median´). The full name of this option for the EsoRex configuration file is **vimos.Parameters.stacking.method** \[default = *Median*\]. - **--KSigmaLow** *\* Low threshold for K-sigma clipping method (float; default: 5.0). The full name of this option for the EsoRex configuration file is **vimos.Parameters.stacking.ksigma.low** \[default = *5.0*\]. - **--KSigmaHigh** *\* High threshold for K-sigma clipping method (float; default: 5.0). The full name of this option for the EsoRex configuration file is **vimos.Parameters.stacking.ksigma.high** \[default = *5.0*\]. - **--MinRejection** *\* Number of lowest rejected values for rejection method (int; default: 1). The full name of this option for the EsoRex configuration file is **vimos.Parameters.minmax.minimum** \[default = *1*\]. - **--MaxRejection** *\* Number of highest rejected values for rejection method (int; default: 1). The full name of this option for the EsoRex configuration file is **vimos.Parameters.minmax.maximum** \[default = *1*\]. - **--BiasMethod** *\* Bias removal method. (str; default: ´Zmaster´). The full name of this option for the EsoRex configuration file is **vimos.Parameters.bias.removing.method** \[default = *Zmaster*\]. - **--CleanBadPixel** *\* Bad pixel correction on master flat (bool; default: False). The full name of this option for the EsoRex configuration file is **vimos.Parameters.badpixel.clean** \[default = *False*\]. - **--CleanCosmic** *\* Cosmic ray events cleaning from raw flats (bool; default: False). The full name of this option for the EsoRex configuration file is **vimos.Parameters.cosmics.clean** \[default = *False*\]. - **--CosmicThreshold** *\* Threshold to identify cosmic rays candidates. (float; default: 4.0). The full name of this option for the EsoRex configuration file is **vimos.Parameters.cosmics.threshold** \[default = *4.0*\]. - **--CosmicRatio** *\* Min ratio between peak and nearby pixels for a cosmic ray. (float; default: 2.0). The full name of this option for the EsoRex configuration file is **vimos.Parameters.cosmics.ratio** \[default = *2.0*\]. - **--ComputeQC** *\* Compute QC1 parameters. (bool; default: True). The full name of this option for the EsoRex configuration file is **vimos.Parameters.quality.enable** \[default = *True*\]. 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 vimos pipeline can be downloaded as a PDF file using the following URL: - **ftp://ftp.eso.org/pub/dfs/pipelines/vimos/vimos-pipeline-manual-6.9.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 vimos pipeline are [*vmbias*(7)](/vmbias/7.md), [*vmdark*(7)](/vmdark/7.md), [*vmdet*(7)](/vmdet/7.md), [*vmifucalib*(7)](/vmifucalib/7.md), [*vmifucombine*(7)](/vmifucombine/7.md), [*vmifucombinecube*(7)](/vmifucombinecube/7.md), [*vmifuscience*(7)](/vmifuscience/7.md), [*vmifustandard*(7)](/vmifustandard/7.md), [*vmimcalphot*(7)](/vmimcalphot/7.md), [*vmimflatscreen*(7)](/vmimflatscreen/7.md), [*vmimobsjitter*(7)](/vmimobsjitter/7.md), [*vmimobsstare*(7)](/vmimobsstare/7.md), [*vmimpreimaging*(7)](/vmimpreimaging/7.md), [*vmimstandard*(7)](/vmimstandard/7.md), [*vmmoscalib*(7)](/vmmoscalib/7.md), [*vmmoscombine*(7)](/vmmoscombine/7.md), [*vmmosobsjitter*(7)](/vmmosobsjitter/7.md), [*vmmosobsstare*(7)](/vmmosobsstare/7.md), [*vmmosscience*(7)](/vmmosscience/7.md), [*vmmosstandard*(7)](/vmmosstandard/7.md), [*vmspcaldisp*(7)](/vmspcaldisp/7.md), [*vmspflat*(7)](/vmspflat/7.md), [*vmspphot*(7)](/vmspphot/7.md) ## VERSION vmimflatsky 3.2.3 ## AUTHOR ESO VIMOS Pipeline Team \ ## BUG REPORTS Please report any problems to usd-help@eso.org. Alternatively, you may send a report to the ESO User Support Department \. ## LICENSE This file is part of the VIMOS Instrument Pipeline Copyright (C) 2002-2005 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 St, Fifth Floor, Boston, MA 02110-1301 USA