.TH VMIMFLATSCREEN "7" "3.3.0" "vmimflatscreen" "vimos recipes" .SH NAME vmimflatscreen \- Create a master screen flat field from set of raw screen flat field frames. .SH SYNOPSIS esorex .B vmimflatscreen [OPTIONS] FILE.sof .SH DESCRIPTION This recipe is used to create a master screen flat field from a set of raw screen flat fields. The master screen flat field is not used directly in the flat field correction of scientific data, but it is optionally used just in the creation of a master sky flat field by the recipe vmimflatsky. .PP Input files: DO category: Type: Explanation: Required: IMG_SCREEN_FLAT Raw Screen flat exposure Y MASTER_BIAS Calib Master bias Y MASTER_DARK Calib Master dark . .PP CCD_TABLE Calib Bad pixel table . .PP Output files: DO category: Data type: Explanation: IMG_MASTER_SCREEN_FLAT FITS image Master screen flat field IMG_COMBINED_SCREEN_FLAT FITS image Combined screen flat field The primary product is the normalised master screen flat field. .PP A secondary product is the combined screen flat field, that is the result of the combination of all inputs but without any normalisation applied, and is just used for data quality control. A CCD table must be specified in input only if a bad pixel cleaning is requested. .PP For more details, please refer to the VIMOS Pipeline User\'s Guide. .SH OPTIONS .TP \fB\-\-SmoothBoxSize\fR \fI\fR Size of running box used for smoothing (int; default: 7). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.smooth.boxsize\fR [default = \fI7\fR]. .TP \fB\-\-SmoothMethod\fR \fI\fR Smooth method for image trends removal (str; default: \'Median\'). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.smooth.method\fR [default = \fIMedian\fR]. .TP \fB\-\-AllowSingleFrames\fR \fI\fR Frame combination method is ignored. (bool; default: True). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.stacking.singleframes\fR [default = \fITrue\fR]. .TP \fB\-\-StackMethod\fR \fI\fR Frames combination method (str; default: \'Average\'). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.stacking.method\fR [default = \fIAverage\fR]. .TP \fB\-\-KSigmaLow\fR \fI\fR Low threshold for K\-sigma clipping method (float; default: 5.0). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.stacking.ksigma.low\fR [default = \fI5.0\fR]. .TP \fB\-\-KSigmaHigh\fR \fI\fR High threshold for K\-sigma clipping method (float; default: 5.0). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.stacking.ksigma.high\fR [default = \fI5.0\fR]. .TP \fB\-\-MinRejection\fR \fI\fR Number of lowest rejected values for rejection method (int; default: 1). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.minmax.minimum\fR [default = \fI1\fR]. .TP \fB\-\-MaxRejection\fR \fI\fR Number of highest rejected values for rejection method (int; default: 1). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.minmax.maximum\fR [default = \fI1\fR]. .TP \fB\-\-BiasMethod\fR \fI\fR Bias removal method (str; default: \'Zmaster\'). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.bias.removing.method\fR [default = \fIZmaster\fR]. .TP \fB\-\-CleanBadPixel\fR \fI\fR Bad pixel correction on master flat (bool; default: False). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.badpixel.clean\fR [default = \fIFalse\fR]. .TP \fB\-\-CleanCosmic\fR \fI\fR Cosmic ray events cleaning from raw flats (bool; default: False). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.cosmics.clean\fR [default = \fIFalse\fR]. .TP \fB\-\-CosmicThreshold\fR \fI\fR Threshold to identify cosmic rays candidates. (float; default: 4.0). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.cosmics.threshold\fR [default = \fI4.0\fR]. .TP \fB\-\-CosmicRatio\fR \fI\fR 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 \fBvimos.Parameters.cosmics.ratio\fR [default = \fI2.0\fR]. .TP \fB\-\-ComputeQC\fR \fI\fR Compute QC1 parameters. (bool; default: True). The full name of this option for the EsoRex configuration file is \fBvimos.Parameters.quality.enable\fR [default = \fITrue\fR]. .PP 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. .SH SEE ALSO The full documentation for the vimos pipeline can be downloaded as a PDF file using the following URL: .IP .B ftp://ftp.eso.org/pub/dfs/pipelines/vimos/vimos\-pipeline\-manual\-6.9.pdf .PP An overview over the existing ESO pipelines can be found on the web page \fBhttps://www.eso.org/sci/software/pipelines/\fR. .PP Basic documentation about the EsoRex program can be found at the esorex (1) man page. .PP It is possible to call the pipelines from python using the python\-cpl package. See \fBhttps://packages.python.org/python\-cpl/index.html\fR for further information. .PP The other recipes of the vimos pipeline are .IR vmbias (7), .IR vmdark (7), .IR vmdet (7), .IR vmifucalib (7), .IR vmifucombine (7), .IR vmifucombinecube (7), .IR vmifuscience (7), .IR vmifustandard (7), .IR vmimcalphot (7), .IR vmimflatsky (7), .IR vmimobsjitter (7), .IR vmimobsstare (7), .IR vmimpreimaging (7), .IR vmimstandard (7), .IR vmmoscalib (7), .IR vmmosscience (7), .IR vmspphot (7) .SH VERSION vmimflatscreen 3.3.0 .SH AUTHOR ESO VIMOS Pipeline Team .SH BUG REPORTS Please report any problems to usd\-help@eso.org. Alternatively, you may send a report to the ESO User Support Department . .SH 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