Provided by: cpl-plugin-hawki-doc_1.8.12+dfsg-2_all bug

NAME

       hawki_step_compute_bkg - Background computing utility

SYNOPSIS

       esorex hawki_step_compute_bkg [OPTIONS] FILE.sof

DESCRIPTION

       hawki_step_compute_bkg -- hawki background computation utility.

       This recipe will create the associated background images for a given set of object images.
       If there are sky images, these will be used to  compute  the  background,  otherwise,  the
       background  is computed using a running mean on the object images. An optional mask can be
       supplied for the running mean.

       The files listed in the Set Of Frames (sof-file) must be  tagged:  obj_basic_cal-file.fits
       BASIC_CALIBRATED or sky_basic_cal-file.fits SKY_BASIC_CALIBRATED and optionally for object
       masking: object_mask-file.fits  OBJ_MASK  offsets.fits  OFFSETS_REFINED  distortion_x.fits
       DISTORTION_X distortion_y.fits DISTORTION_Y

OPTIONS

       --nmin_comb <long>
              Minimum  number of jitter frames to use the running median (long; default: 10). The
              full   name   of   this   option   for   the   EsoRex   configuration    file    is
              hawki.hawki_step_compute_bkg.nmin_comb [default = 10].

       --nhalf_window <long>
              Number  of images at both sides of the current ima to use for bkg in running median
              (long; default: 7). The full name of this option for the EsoRex configuration  file
              is hawki.hawki_step_compute_bkg.nhalf_window [default = 7].

       --rejlow <long>
              The  number of frames with low level to reject (long; default: 2). The full name of
              this      option      for      the      EsoRex      configuration      file      is
              hawki.hawki_step_compute_bkg.rejlow [default = 2].

       --rejhigh <long>
              The number of frames with high level to reject (long; default: 2). The full name of
              this      option      for      the      EsoRex      configuration      file      is
              hawki.hawki_step_compute_bkg.rejhigh [default = 2].

       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 hawki pipeline can be downloaded as a PDF file using the
       following URL:

              ftp://ftp.eso.org/pub/dfs/pipelines/hawki/hawki-pipeline-manual-1.8.12.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 hawki  pipeline  are  hawki_step_stitch(7),  hawki_cal_zpoint(7),
       hawki_util_gendist(7),             hawki_step_apply_dist(7),            hawki_cal_flat(7),
       hawki_step_detect_obj(7),        hawki_util_stdstars(7),        hawki_step_basic_calib(7),
       hawki_step_photom_2mass(7),        hawki_util_extinction(7),        hawki_step_combine(7),
       hawki_cal_dark(7), hawki_sci_jitter(7), hawki_tec_filtchk(7),  hawki_step_subtract_bkg(7),
       hawki_step_refine_offsets(7), hawki_cal_distortion(7), hawki_step_stats(7)

VERSION

       hawki_step_compute_bkg 1.8.12

AUTHOR

       Cesar Enrique Garcia Dabo <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  HAWKI  Instrument  Pipeline  Copyright  (C)  2002,2011  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