xenial (7) sinfo_utl_cube_combine.7.gz

NAME

       sinfo_utl_cube_combine - Coadd cubes in an output cube according to user defined offsets

SYNOPSIS

       esorex sinfo_utl_cube_combine [OPTIONS] FILE.sof

DESCRIPTION

       This recipe perform cubes combination.

       The  input  files  are  several cubeses their associated tags should be the same that is supported by the
       recipe sinfo_rec_jitter: OBS_OBJ, OBS_STD, OBS_PSF.

       The output is a cube PRO_CUBE resulting from the input cubes accurding to  the  value  of  op,  where  op
       indicates the operation to be performed specified by the parameter sinfoni.sinfo_utl_cube_combine.op
        having alias ´op´

OPTIONS

       --name_i <str>
              Input  filename.  This  must be provided and allow the user to set X and Y cumulative offsets in a
              two column format (str; default: ´offset.list´). The full name  of  this  option  for  the  EsoRex
              configuration file is sinfoni.sinfo_utl_cube_combine.name_i [default = offset.list].

       --name_o <str>
              Output filename (str; default: ´out_coadd_cube.fits´). The full name of this option for the EsoRex
              configuration file is sinfoni.sinfo_utl_cube_combine.name_o [default = out_coadd_cube.fits].

       --ks_clip <bool>
              Kappa sigma clipping (bool; default:  False).  The  full  name  of  this  option  for  the  EsoRex
              configuration file is sinfoni.sinfo_utl_cube_combine.ks_clip [default = False].

       --scale_sky <bool>
              Scale  spatial  mean  (bool;  default:  False).  The  full  name  of  this  option  for the EsoRex
              configuration file is sinfoni.sinfo_utl_cube_combine.scale_sky [default = False].

       --kappa <float>
              Kappa value for sigma clip (float; default: 2.0). The full name of  this  option  for  the  EsoRex
              configuration file is sinfoni.sinfo_utl_cube_combine.kappa [default = 2.0].

       --xsize <long>
              Output  cube X size (long; default: 80). The full name of this option for the EsoRex configuration
              file is sinfoni.sinfo_utl_cube_combine.xsize [default = 80].

       --ysize <long>
              Output cube Y size (long; default: 80). The full name of this option for the EsoRex  configuration
              file is sinfoni.sinfo_utl_cube_combine.ysize [default = 80].

       --offset_mode <bool>
              Offset  conventions. If TRUE applies reference offset correction. If FALSE: take user offsets. The
              reference offset is computed as (min_off+max_off)/2 (bool; default: True). The full name  of  this
              option  for the EsoRex configuration file is sinfoni.sinfo_utl_cube_combine.offset_mode [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 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_create(7),               sinfo_utl_ima_arith(7),               sinfo_utl_ima_line_corr(7),
       sinfo_utl_line_oh_select(7),                   sinfo_utl_skycor(7),                  sinfo_utl_skymap(7),
       sinfo_utl_spectrum_divide_by_blackbody(7), sinfo_utl_spectrum_wavelength_shift(7)

VERSION

       sinfo_utl_cube_combine 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