xenial (7) fors_sumflux.7.gz

Provided by: cpl-plugin-fors-doc_5.1.4+dfsg-2_all bug

NAME

       fors_sumflux - Integrate flux from all or part of the input frame

SYNOPSIS

       esorex fors_sumflux [OPTIONS] FILE.sof

DESCRIPTION

       This  recipe  is  used  to  monitor  any  lamp  flux  on  the CCD. The input raw image should be either a
       FLUX_ARC_LSS or a FLUX_FLAT_LSS frame. After the background subtraction the total  signal  is  integrated
       and  divided  by the exposure time and by the total number of CCD original pixels (keeping into account a
       possible rebinned readout). In the case of FORS2 frames the background is the median level evaluated from
       the  available  overscan  regions.  In  the  case  of FORS1 data, where overscan regions are missing, the
       background is evaluated as the median level of the first 200 CCD columns for flat field data,  while  for
       arc  lamp  data  a  background  map  evaluated  from  the  regions without spectral lines is computed and
       subtracted. The background subtracted frame is written to output in all cases, and the QC  parameters  QC
       LAMP FLUX and QC LAMP FLUXERR are computed.

       Input files:

         DO category:      Type:       Explanation:         Required:
         FLUX_FLAT_LSS     Raw         Flat field exposure     Y
         or FLUX_ARC_LSS   Raw         Arc lamp exposure       Y

       Output files:

         DO category:      Data type:  Explanation:
         FLUX_LAMP_LSS     FITS image  Background subtracted integration region

OPTIONS

       --xlow <long>
              X  coordinate of lower left corner of integration region (pixel) (long; default: 0). The full name
              of this option for the EsoRex configuration file is fors.fors_sumflux.xlow [default = 0].

       --ylow <long>
              Y coordinate of lower left corner of integration region (pixel) (long; default: 0). The full  name
              of this option for the EsoRex configuration file is fors.fors_sumflux.ylow [default = 0].

       --xhigh <long>
              X  coordinate  of  upper right corner of integration region (pixel) (0 = CCD size) (long; default:
              0). The full name of this option for the  EsoRex  configuration  file  is  fors.fors_sumflux.xhigh
              [default = 0].

       --yhigh <long>
              Y  coordinate  of  upper right corner of integration region (pixel) (0 = CCD size) (long; default:
              0). The full name of this option for the  EsoRex  configuration  file  is  fors.fors_sumflux.yhigh
              [default = 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 fors pipeline can be downloaded as a PDF file using the following URL:

              ftp://ftp.eso.org/pub/dfs/pipelines/fors/fors-pipeline-manual-4.9.pdf

       An   overview   over   the   existing   ESO   pipelines    can    be    found    on    the    web    page
       http://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
       http://packages.python.org/python-cpl/index.html for further information.

       The other recipes of  the  fors  pipeline  are  fors_align_sky(7),  fors_align_sky_lss(7),  fors_bias(7),
       fors_calib(7),     fors_config(7),    fors_dark(7),    fors_detect_objects(7),    fors_detect_spectra(7),
       fors_extract(7), fors_extract_objects(7), fors_extract_slits(7), fors_flatfield(7),  fors_img_science(7),
       fors_img_screen_flat(7),      fors_img_sky_flat(7),      fors_normalise_flat(7),      fors_photometry(7),
       fors_pmos_calib(7), fors_pmos_extract(7),  fors_pmos_science(7),  fors_remove_bias(7),  fors_resample(7),
       fors_science(7),  fors_spec_mflat(7), fors_subtract_sky(7), fors_subtract_sky_lss(7), fors_trace_flat(7),
       fors_wave_calib(7), fors_wave_calib_lss(7), fors_zeropoint(7), montecarlo(7), test_hough(7)

VERSION

       fors_sumflux 5.1.4

AUTHOR

       Carlo Izzo <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  currently  part of the FORS Instrument Pipeline Copyright (C) 2002-2010 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