Provided by: cpl-plugin-vimos-doc_3.2.3+dfsg-2build3_all bug

NAME

       vmimflatscreen  -  Create  a  master  screen  flat field from set of raw screen flat field
       frames.

SYNOPSIS

       esorex vmimflatscreen [OPTIONS] FILE.sof

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.

       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             .

         CCD_TABLE                 Calib       Bad pixel table         .

       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.

       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.

       For more details, please refer to the VIMOS Pipeline User´s Guide.

OPTIONS

       --SmoothBoxSize <int>
              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 <str>
              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 <bool>
              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 <str>
              Frames combination method (str; default: ´Average´). The full name of  this  option
              for  the  EsoRex  configuration file is vimos.Parameters.stacking.method [default =
              Average].

       --KSigmaLow <float>
              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 <float>
              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 <int>
              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 <int>
              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 <str>
              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 <bool>
              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 <bool>
              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 <float>
              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 <float>
              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 <bool>
              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), vmdark(7), vmdet(7), vmifucalib(7),
       vmifucombine(7),  vmifucombinecube(7),  vmifuscience(7), vmifustandard(7), vmimcalphot(7),
       vmimflatsky(7),  vmimobsjitter(7),  vmimobsstare(7),  vmimpreimaging(7),  vmimstandard(7),
       vmmoscalib(7),   vmmoscombine(7),  vmmosobsjitter(7),  vmmosobsstare(7),  vmmosscience(7),
       vmmosstandard(7), vmspcaldisp(7), vmspflat(7), vmspphot(7)

VERSION

       vmimflatscreen 3.2.3

AUTHOR

       ESO VIMOS Pipeline Team <usd-help@eso.org>

BUG REPORTS

       Please report any problems to usd-help@eso.org. Alternatively, you may send  a  report  to
       the ESO User Support Department <usd-help@eso.org>.

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