xenial (7) sinfo_utl_skycor.7.gz

Provided by: cpl-plugin-sinfo-doc_2.7.0+dfsg-1_all bug

NAME

       sinfo_utl_skycor - Sky lines residuals correction

SYNOPSIS

       esorex sinfo_utl_skycor [OPTIONS] FILE.sof

DESCRIPTION

       This  recipe  perform  a correction of possible sky line residuals in the object cube after standard data
       reduction.

       Input frames are cubes with target and sky observations.

       Their tags can be respectively OBS_OBJ (or OBS_PSF or OBS_STD) and OBS_SKY.

       The output is a cube with same tag as the corresponding input target frame.

OPTIONS

       --skycor-mask_ws <float>
              Starting wavelength for object-sky cross correlation (float; default: 1.4). The full name of  this
              option for the EsoRex configuration file is sinfoni.sinfo_utl_skycor.mask_ws [default = 1.4].

       --skycor-mask_we <float>
              End  wavelength  for  object-sky  cross  correlation  (float; default: 2.5). The full name of this
              option for the EsoRex configuration file is sinfoni.sinfo_utl_skycor.mask_we [default = 2.5].

       --skycor-min_frac <float>
              Threshold value for fraction of spatial pixels to be sky (float; default: 0.8). The full  name  of
              this  option  for  the  EsoRex  configuration file is sinfoni.sinfo_utl_skycor.min_frac [default =
              0.8].

       --skycor-sky_bkg_filter_width <long>
              Width of sky-thermal background pre filter (to remove emission lines before fitting a Black Body).
              (long;  default:  12).  The  full  name  of  this  option  for  the  EsoRex  configuration file is
              sinfoni.sinfo_utl_skycor.sky_bkg_filter_width [default = 12].

       --skycor-line_hw <float>
              Threshold value for full width in pixels of unresolved emission line.   Lines  with  FWHM  smaller
              than  this  value are not considered in the object-sky cross correlation and in computation of the
              optimal sky lines scaling factor (float; default: 4.0). The full  name  of  this  option  for  the
              EsoRex configuration file is sinfoni.sinfo_utl_skycor.line_half_width [default = 4.0].

       --skycor-scale_method <long>
              Optimal  sky  lines  scaling  factor  computation  method:  amoeba fit (0), maximum likelihood (1)
              (long; default:  1).  The  full  name  of  this  option  for  the  EsoRex  configuration  file  is
              sinfoni.sinfo_utl_skycor.scale_method [default = 1].

       --skycor-rot_cor <bool>
              Computes  scaling  factor  correction due to rotational levels transitions (bool; default: False).
              The full name of this option for the EsoRex configuration file is sinfoni.sinfo_utl_skycor.rot_cor
              [default = False].

       --skycor-fit_obj_noise <bool>
              Do  Gaussian  fit  of  object  noise  (bool; default: False). The full name of this option for the
              EsoRex configuration file is sinfoni.sinfo_utl_skycor.fit_obj_noise [default = False].

       --skycor-niter <long>
              Number of iterations of background fit (long; default: 10). The full name of this option  for  the
              EsoRex configuration file is sinfoni.sinfo_utl_skycor.niter [default = 10].

       --skycor-pshift <float>
              Sky spectrum shift towar object (float; default: 0.0). The full name of this option for the EsoRex
              configuration file is sinfoni.sinfo_utl_skycor.pshift [default = 0.0].

       --skycor-llx <long>
              Lower left X defining object spectrum location (long; default: 1). The full name  of  this  option
              for the EsoRex configuration file is sinfoni.sinfo_utl_skycor.llx [default = 1].

       --skycor-lly <long>
              Lower  left  Y  defining object spectrum location (long; default: 1). The full name of this option
              for the EsoRex configuration file is sinfoni.sinfo_utl_skycor.lly [default = 1].

       --skycor-urx <long>
              Upper right X defining object spectrum location (long; default: 64). The full name of this  option
              for the EsoRex configuration file is sinfoni.sinfo_utl_skycor.urx [default = 64].

       --skycor-ury <long>
              Upper  right Y defining object spectrum location (long; default: 64). The full name of this option
              for the EsoRex configuration file is sinfoni.sinfo_utl_skycor.ury [default = 64].

       --skycor-sub_thr_bkg_from_obj <bool>
              Subtract thermal background contribute from object spectra. Set it to TRUE if stack-sub_raw_sky is
              set  to  FALSE  (bool;  default: False). The full name of this option for the EsoRex configuration
              file is sinfoni.sinfo_utl_skycor.sub_thr_bkg_from_obj [default = False].

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

              ftp://ftp.eso.org/pub/dfs/pipelines/sinfoni/sinfo-pipeline-manual-19.0.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   sinfo   pipeline   are  sinfo_rec_detlin(7),  sinfo_rec_distortion(7),
       sinfo_rec_jitter(7), sinfo_rec_mdark(7),  sinfo_rec_mflat(7),  sinfo_rec_pupil(7),  sinfo_rec_wavecal(7),
       sinfo_utl_bp_mask_add(7),   sinfo_utl_cube2ima(7),  sinfo_utl_cube2spectrum(7),  sinfo_utl_cube_arith(7),
       sinfo_utl_cube_combine(7), sinfo_utl_cube_create(7), sinfo_utl_ima_arith(7),  sinfo_utl_ima_line_corr(7),
       sinfo_utl_line_oh_select(7),        sinfo_utl_skymap(7),       sinfo_utl_spectrum_divide_by_blackbody(7),
       sinfo_utl_spectrum_wavelength_shift(7)

VERSION

       sinfo_utl_skycor 2.7.0

AUTHOR

       Andrea Modigliani <Andrea.Modigliani@eso.org>

BUG REPORTS

       Please report any problems to Andrea.Modigliani@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  SINFONI  Instrument  Pipeline  Copyright  (C)  2002,2003 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