noble (7) vimos_ima_science.7.gz

Provided by: cpl-plugin-vimos-doc_4.1.7+dfsg-2build3_all bug

NAME

       vimos_ima_science - Science processing for imaging

SYNOPSIS

       esorex vimos_ima_science [OPTIONS] FILE.sof

DESCRIPTION

       vimos_ima_science -- VIMOS science recipe.

       Take a list of science frames and correct them to remove bias, dark and flat field signatures. Optionally
       defringe the reddest filter images. Stack jitter sequences. Astrometrically and photometrically calibrate
       the stacks

       The program accepts the following files in the SOF:

           Tag                   Description

           OBJECT                A list of raw science images
           MASTER_BIAS           A master bias frame
           MASTER_DARK           A master dark frame
           MASTER_TWILIGHT_FLAT  A master flat frame
           MASTER_CONF           A master confidence map
           MASTER_FRINGE         A master fringe map (optional)
           MASTER_FRINGE_VAR     A master fringe variance map (optional)
           MASTER_READGAIN       A master readgain table
           MASTER_2MASS_CATALOGUE_ASTROM A master 2MASS index for astrometry or
           MASTER_PPMXL_CATALOGUE_ASTROM A master PPMXL index for astrometry or
           MASTER_APASS_CATALOGUE_ASTROM A master APASS index for astrometry or
           MASTER_LOCAL_CATALOGUE_ASTROM A master local index for astrometry
           MASTER_APASS_CATALOGUE_PHOTOM A master APASS index for photometry or
           MASTER_LOCAL_CATALOGUE_PHOTOM A master local index for photometry or
           OBJECT_CATALOGUE_STD  A master processed standard star image or table
           MATCHSTD_PHOTOM       A master photometric matched standards table (optional)
           SCHLEGEL_MAP_NORTH    Northern Schlegel Map
           SCHLEGEL_MAP_SOUTH    Southern Schlegel Map
           PHOTCAL_TAB            A  photometric  calibration  table  All of these are required unless specified
       otherwise.

OPTIONS

       --savecat <bool>
              Save catalogue? (bool; default: False). The full name of this option for the EsoRex  configuration
              file is vimos.vimos_ima_science.savecat [default = False].

       --savemstd <bool>
              Save  matched  standard  catalogues?  (bool; default: False). The full name of this option for the
              EsoRex configuration file is vimos.vimos_ima_science.savemstd [default = False].

       --preview_only <bool>
              Preview only? (bool; default: False). The full name of this option for  the  EsoRex  configuration
              file is vimos.vimos_ima_science.preview_only [default = False].

       --minphotom <int>
              Minimum  stars  for  photometry  solution  (int; default: 1). The full name of this option for the
              EsoRex configuration file is vimos.vimos_ima_science.minphotom [default = 1].

       --prettynames <bool>
              Use pretty product names? (bool; default: False). The full name of  this  option  for  the  EsoRex
              configuration file is vimos.vimos_ima_science.prettynames [default = False].

       --chop_crud <str>
              Chop  crud  method  (str;  default:  ´hardconf_pix´).  The full name of this option for the EsoRex
              configuration file is vimos.vimos_ima_science.chop_crud [default = hardconf_pix].

       --cdssearch_astrom <str>
              CDS astrometric catalogue (str; default: ´none´). The full name of  this  option  for  the  EsoRex
              configuration file is vimos.vimos_ima_science.cdssearch_astrom [default = none].

       --cdssearch_photom <str>
              CDS  photometric  catalogue  (str;  default:  ´none´). The full name of this option for the EsoRex
              configuration file is vimos.vimos_ima_science.cdssearch_photom [default = none].

       --ignore_fringe <bool>
              Ignore provided fringe frame? (bool; default: False). The full name of this option for the  EsoRex
              configuration file is vimos.vimos_ima_science.ignore_fringe [default = False].

       --stk_cat_ipix <int>
              Minimum  pixel  area for each detected object (int; default: 10). The full name of this option for
              the EsoRex configuration file is vimos.vimos_ima_science.stk_cat_ipix [default = 10].

       --stk_cat_thresh <float>
              Detection threshold in sigma above sky (float; default: 1.5). The full name of this option for the
              EsoRex configuration file is vimos.vimos_ima_science.stk_cat_thresh [default = 1.5].

       --stk_cat_icrowd <bool>
              Use  deblending?  (bool; default: True). The full name of this option for the EsoRex configuration
              file is vimos.vimos_ima_science.stk_cat_icrowd [default = True].

       --stk_cat_rcore <float>
              Value of Rcore in pixels (float; default: 10.0). The full name  of  this  option  for  the  EsoRex
              configuration file is vimos.vimos_ima_science.stk_cat_rcore [default = 10.0].

       --stk_cat_nbsize <int>
              Background  smoothing  box  size  (int; default: 128). The full name of this option for the EsoRex
              configuration file is vimos.vimos_ima_science.stk_cat_nbsize [default = 128].

       --stk_lthr <float>
              Low rejection threshold (float; default: 3.0). The  full  name  of  this  option  for  the  EsoRex
              configuration file is vimos.vimos_ima_science.stk_lthr [default = 3.0].

       --stk_hthr <float>
              Upper  rejection  threshold  (float;  default:  3.0).  The full name of this option for the EsoRex
              configuration file is vimos.vimos_ima_science.stk_hthr [default = 3.0].

       --stk_method <str>
              Stacking  method  (str;  default:  ´linear´).  The  full  name  of  this  option  for  the  EsoRex
              configuration file is vimos.vimos_ima_science.stk_method [default = linear].

       --stk_seeing <bool>
              Weight  by  seeing?  (bool;  default:  False).  The  full  name  of  this  option  for  the EsoRex
              configuration file is vimos.vimos_ima_science.stk_seeing [default = False].

       --stk_fast <str>
              Stack using fast algorithm? (str; default: ´auto´). The full name of this option  for  the  EsoRex
              configuration file is vimos.vimos_ima_science.stk_fast [default = auto].

       --stk_nfst <int>
              Nframes  to  stack  in  fast  mode (int; default: 16). The full name of this option for the EsoRex
              configuration file is vimos.vimos_ima_science.stk_nfst [default = 16].

       --cacheloc <str>
              Location for standard star cache (str; default: ´.´). The full name of this option for the  EsoRex
              configuration file is vimos.vimos_ima_science.cacheloc [default = .].

       --magerrcut <float>
              Magnitude  error  cut  (float;  default:  100.0).  The  full  name  of  this option for the EsoRex
              configuration file is vimos.vimos_ima_science.magerrcut [default = 100.0].

       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 vimos_ima_bias(7), vimos_ima_dark(7), vimos_ima_det_noise(7),
       vimos_ima_fringe(7), vimos_ima_standard(7), vimos_ima_twilight_flat(7), vmbias(7),  vmdark(7),  vmdet(7),
       vmifucalib(7),  vmifucombine(7),  vmifucombinecube(7),  vmifuscience(7), vmifustandard(7), vmmoscalib(7),
       vmmosscience(7), vmspphot(7)

VERSION

       vimos_ima_science 4.1.7

AUTHOR

       Jim Lewis <jrl@ast.cam.ac.uk>

BUG REPORTS

       Please report any problems to jrl@ast.cam.ac.uk. 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) 2019 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA